Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP #20705

Closed
wants to merge 1 commit into from
Closed

WIP #20705

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 26 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
<a href="https://www.gitpod.io">
<img width="1500" alt="Gitpod banner image" src="https://github.com/gitpod-io/gitpod/assets/55068936/ff393a65-a4f3-4997-a066-10337562cc34">
</a>
</a>1

<br>
<br>



<div align="center" style="flex-direction: row;">
<a href="https://www.gitpod.io#gh-light-mode-only">
<img src="https://github.com/gitpod-io/gitpod/assets/55068936/01a00b23-e1f5-4650-a629-89db8e300708" style="width: 256px">
Expand All @@ -16,12 +14,10 @@
</a>
</div>


[Gitpod](https://www.gitpod.io)’s developer platform provides on-demand, pre-configured environments that automatically integrate into any tool, library, or dependency required for creating software. Gitpod workspaces are the fastest and most secure way to ship software and are as easy as adding a `.gitpod.yml` file to the root of any repository.

📄 [Read Cloud Development Environment white paper](https://www.gitpod.io/whitepaper/cde)


<div align="center" style="flex-direction: row;">
<a href="https://www.gitpod.io#gh-light-mode-only">
<img src="https://github.com/gitpod-io/gitpod/assets/55068936/84beb5da-fa5b-4966-a454-8f5b2607a8ed">
Expand All @@ -31,38 +27,34 @@
</a>
</div>



## Features

- **Dev environments as code** - Gitpod is like infrastructure-as-code, but for your development environment. Gitpod defines your editor extensions and requires dependencies in a declarative [`.gitpod.yml` configuration](https://www.gitpod.io/docs/introduction/gitpod-tutorial/2-configure-your-gitpod-yml). Spinning up dev environments is easily repeatable and reproducible empowering you to automate, version-control, and share dev environments across your team.
- [**Prebuilt dev environments**](https://www.gitpod.io/docs/configure/projects/prebuilds) - Gitpod continuously prebuilds all your git branches similar to a CI server. Control how Gitpod pre-configures and initializes environments before you even start a workspace through tasks commands in your .gitpod.yml. No more watching apt-get or npm install again. 
- [**Secure**](https://www.gitpod.io/security) - Each Gitpod workspace or prebuild runs on a secured single-use container providing fast startup times without compromising on security. Gitpod generates SLSA level 1 compliant provenance. Gitpod is also GDPR and SOC2 compliant. And, of course, Gitpod is open-source and available for review by everyone.
- **Workspaces based on Docker** - Gitpod instantly starts a container in the cloud based on an (optional) [Docker image](https://www.gitpod.io/docs/config-docker/). If you’re already using Docker, you can easily re-use your Docker file. 
- **GitLab, GitHub, Bitbucket and Azure DevOps integration** - Gitpod seamlessly [integrates](https://www.gitpod.io/docs/configure/authentication) into your workflow and works with all major Git hosting platforms including GitHub, GitLab, Bitbucket, and Azure DevOps.
- **Integrated code reviews** - with Gitpod you can do native code reviews on any PR/MR. No need to switch contexts anymore and clutter your local machine with your colleagues' PR/MR.
- **Collaboration** - invite team members to your dev environment or snapshot of any state of your dev environment to share it with your team asynchronously.
**Professional & customizable developer experience** - a Gitpod workspace gives you the same capabilities as your Linux machine - pre-configured and optimized for your development workflow. Install any [VS Code extension](https://www.gitpod.io/docs/references/ides-and-editors/vscode-extensions) with one click on a user and/or team level. You can also bring your [dotfiles](https://www.gitpod.io/docs/configure/user-settings/dotfiles#dotfiles) and customize your dev environment as you like.

- **Dev environments as code** - Gitpod is like infrastructure-as-code, but for your development environment. Gitpod defines your editor extensions and requires dependencies in a declarative [`.gitpod.yml` configuration](https://www.gitpod.io/docs/introduction/gitpod-tutorial/2-configure-your-gitpod-yml). Spinning up dev environments is easily repeatable and reproducible empowering you to automate, version-control, and share dev environments across your team.
- [**Prebuilt dev environments**](https://www.gitpod.io/docs/configure/projects/prebuilds) - Gitpod continuously prebuilds all your git branches similar to a CI server. Control how Gitpod pre-configures and initializes environments before you even start a workspace through tasks commands in your .gitpod.yml. No more watching apt-get or npm install again.
- [**Secure**](https://www.gitpod.io/security) - Each Gitpod workspace or prebuild runs on a secured single-use container providing fast startup times without compromising on security. Gitpod generates SLSA level 1 compliant provenance. Gitpod is also GDPR and SOC2 compliant. And, of course, Gitpod is open-source and available for review by everyone.
- **Workspaces based on Docker** - Gitpod instantly starts a container in the cloud based on an (optional) [Docker image](https://www.gitpod.io/docs/config-docker/). If you’re already using Docker, you can easily re-use your Docker file.
- **GitLab, GitHub, Bitbucket and Azure DevOps integration** - Gitpod seamlessly [integrates](https://www.gitpod.io/docs/configure/authentication) into your workflow and works with all major Git hosting platforms including GitHub, GitLab, Bitbucket, and Azure DevOps.
- **Integrated code reviews** - with Gitpod you can do native code reviews on any PR/MR. No need to switch contexts anymore and clutter your local machine with your colleagues' PR/MR.
- **Collaboration** - invite team members to your dev environment or snapshot of any state of your dev environment to share it with your team asynchronously.
**Professional & customizable developer experience** - a Gitpod workspace gives you the same capabilities as your Linux machine - pre-configured and optimized for your development workflow. Install any [VS Code extension](https://www.gitpod.io/docs/references/ides-and-editors/vscode-extensions) with one click on a user and/or team level. You can also bring your [dotfiles](https://www.gitpod.io/docs/configure/user-settings/dotfiles#dotfiles) and customize your dev environment as you like.

## Getting Started

- **Browser**: 
- Using Gitpod dashboard [gitpod.io/new](https://gitpod.io/new).
- Add `gitpod.io/# `as a prefix to any of your GitHub/ GitLab/ Bitbucket repository, like [this](https://gitpod.io/#https://github.com/gitpod-io/template-typescript-react)
- **CLI**: You can also [install the Gitpod CLI](https://www.gitpod.io/docs/references/gitpod-cli#installation) and create your first workspace directly from your terminal :)

- **Browser**:
- Using Gitpod dashboard [gitpod.io/new](https://gitpod.io/new).
- Add `gitpod.io/# `as a prefix to any of your GitHub/ GitLab/ Bitbucket repository, like [this](https://gitpod.io/#https://github.com/gitpod-io/template-typescript-react)
- **CLI**: You can also [install the Gitpod CLI](https://www.gitpod.io/docs/references/gitpod-cli#installation) and create your first workspace directly from your terminal :)

## Documentation

All documentation can be found on [www.gitpod.io/docs](https://www.gitpod.io/docs). For example, see [Gitpod tutorial](https://www.gitpod.io/docs/introduction/gitpod-tutorial) and check the following helpful resources:
- [Workspace Lifecycle](https://www.gitpod.io/docs/configure/workspaces/workspace-lifecycle)
- [Configure repositories](https://www.gitpod.io/docs/configure/repositories)
- [Organizations](https://www.gitpod.io/docs/configure/orgs)
- [IDE & Editors support](https://www.gitpod.io/docs/references/ides-and-editors)
- [Video screencasts](https://www.gitpod.io/screencasts)
- [Gitpod samples](https://github.com/gitpod-samples)

- [Workspace Lifecycle](https://www.gitpod.io/docs/configure/workspaces/workspace-lifecycle)
- [Configure repositories](https://www.gitpod.io/docs/configure/repositories)
- [Organizations](https://www.gitpod.io/docs/configure/orgs)
- [IDE & Editors support](https://www.gitpod.io/docs/references/ides-and-editors)
- [Video screencasts](https://www.gitpod.io/screencasts)
- [Gitpod samples](https://github.com/gitpod-samples)

## Questions

Expand All @@ -77,16 +69,16 @@ The issue tracker is used for tracking bug reports and feature requests for the

You can upvote popular feature requests or create a new one.


## Related Projects

During the development of Gitpod, we also developed some of our infrastructure toolings to make development easier and more efficient. To this end, we've developed many open-source projects including:
- [Workspace images](https://github.com/gitpod-io/workspace-images): Ready to use docker images for Gitpod workspaces
- [OpenVSCode Server](https://github.com/gitpod-io/openvscode-server): Run the latest VS Code on a remote machine accessed through a browser
- [Gitpod browser extension](https://github.com/gitpod-io/browser-extension): It adds a Gitpod button to the configured GitLab, GitHub, Bitbucket and Azure DevOps installations
- [Leeway](https://github.com/gitpod-io/leeway) - A heavily caching build system
- [Dazzle](https://github.com/gitpod-io/dazzle) - An experimental Docker image builder
- [Werft](https://github.com/csweichel/werft) - A Kubernetes native CI system

- [Workspace images](https://github.com/gitpod-io/workspace-images): Ready to use docker images for Gitpod workspaces
- [OpenVSCode Server](https://github.com/gitpod-io/openvscode-server): Run the latest VS Code on a remote machine accessed through a browser
- [Gitpod browser extension](https://github.com/gitpod-io/browser-extension): It adds a Gitpod button to the configured GitLab, GitHub, Bitbucket and Azure DevOps installations
- [Leeway](https://github.com/gitpod-io/leeway) - A heavily caching build system
- [Dazzle](https://github.com/gitpod-io/dazzle) - An experimental Docker image builder
- [Werft](https://github.com/csweichel/werft) - A Kubernetes native CI system

## Code of Conduct

Expand Down
Loading