Getting Started
Gitpod is an open source platform for automated and ready-to-code development environments that blends into your existing workflow.
For an overview of Gitpod you should first read Introduction to Gitpod.
You can start using Gitpod with one or more of the following ways:
- Use a Prefixed URL
- Install Browser Extension
- Enable GitLab Integration
- Quick start using an Example Project or OSS Project
Prefixed URL
You can quickly open a new workspace for your project using a context URL like repository, branch, pull request, issue, or file. Just prefix the URL in the address bar of your browser with gitpod.io/#
.
For example, try opening https://gitpod.io/#https://gitlab.com/gitpod/spring-petclinic or https://gitlab.com/gitpod/spring-petclinic/-/merge_requests/2.
Browser Extension
For convenience, we’ve made a browser extension that works with Google Chrome and Mozilla Firefox. The extension adds a Gitpod button on every project and branch across GitLab, GitHub, and Bitbucket so you can easily open a new workspace for any existing project.
GitLab Integration
GitLab comes with a native Gitpod which is enabled by default for GitLab.com. To use the GitLab integration, you need to enable it from your user preferences at GitLab. Then you can choose to open a Gitpod workspace as an alternative to the GitLab Web IDE directly from GitLab for any existing project.
Example Project
Many example projects already have a working Gitpod configuration. We’ve listed a few of them in Example Projects so that you can inspect their configurations and try them out in Gitpod.
For instance, you could try opening Vuepress or a Java with Spring Boot example.
Gitpodified Open Source Projects
Setting up a local dev environment for a contribution to your favourite OSS project can be daunting. Luckily there are already numerous projects out there that gitpodified their repositories allowing everyone to contribute with a single click. With contribute.dev we even made a website to list them.
See for yourself and try opening some of our favorite OSS projects out there:
- freeCodeCamp
- Prometheus
- GitLab
- Forem powering dev.to
- Nushell
Next Steps
With Gitpod you start treating your dev environments as something ephemeral: you start them, you code, you push your code, and you forget about them. For your next task, you’ll use a fresh dev environment.
🛠 Gitpodify your first project!