VS Code in the browser
Go to file
Joe Previte d15731a570
docs: update sections around VS Code fork (#4571)
* docs(CONTRIBUTING): update workflow based on vscode changes

* docs(MAINTAINING): add section for syncing VS Code upstream

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2021-12-06 17:58:04 +00:00
.github chore(deps): update minor dependency updates (#4531) 2021-11-29 11:31:35 -07:00
.tours Add vscode via vendor package. 2021-09-15 14:54:33 -04:00
ci Fix issues surrounding initial web server load. (#4509) 2021-11-19 16:03:40 -05:00
docs docs: update sections around VS Code fork (#4571) 2021-12-06 17:58:04 +00:00
src Proxy path fixes (#4548) 2021-12-01 18:21:52 -06:00
test Proxy path fixes (#4548) 2021-12-01 18:21:52 -06:00
typings Refactor vscode endpoints to use fork directly. 2021-09-30 19:14:17 -04:00
vendor Proxy path fixes (#4548) 2021-12-01 18:21:52 -06:00
.dockerignore Simplify packaging and improve scripts 2020-05-08 01:04:24 -04:00
.editorconfig Refactor vscode endpoints to use fork directly. 2021-09-30 19:14:17 -04:00
.eslintrc.yaml fix: remove eslint-plugin-jest-playwright 2021-04-29 10:46:14 -07:00
.gitattributes browser: Add favicon.afdesign 2021-01-08 23:03:34 -05:00
.gitignore Revert "Add linkup command to improve link functionality" (#4439) 2021-11-03 14:42:14 -07:00
.node-version chore: Update dependency requirements. Fix node version manager. 2021-07-21 14:32:16 -04:00
.nvmrc chore: Update dependency requirements. Fix node version manager. 2021-07-21 14:32:16 -04:00
.prettierrc.yaml Refactor vscode endpoints to use fork directly. 2021-09-30 19:14:17 -04:00
.stylelintrc.yaml Fix bugs in CI 2020-02-18 19:06:35 -05:00
CHANGELOG.md Update changelog (#4492) 2021-11-10 16:45:19 -06:00
LICENSE.txt Shake CI and docs up 2020-02-14 19:46:17 -05:00
ThirdPartyNotices.txt Add ThirdPartyNotices.txt 2020-07-16 19:01:09 -06:00
install.sh fix(docs): use latest instead of version in links 2021-08-24 11:54:46 -07:00
package.json fix(deps): update dependency qs to v6.10.2 (#4581) 2021-12-06 10:33:13 -07:00
renovate.json Add vscode via vendor package. 2021-09-15 14:54:33 -04:00
tsconfig.json Refactor vscode endpoints to use fork directly. 2021-09-30 19:14:17 -04:00
yarn.lock fix(deps): update dependency qs to v6.10.2 (#4581) 2021-12-06 10:33:13 -07:00

docs/README.md

code-server

"GitHub Discussions" "Join us on Slack" Twitter Follow codecov See v3.12.0 docs

Run VS Code on any machine anywhere and access it in the browser.

Screenshot

Highlights

  • Code on any device with a consistent development environment
  • Use cloud servers to speed up tests, compilations, downloads, and more
  • Preserve battery life when you're on the go; all intensive tasks run on your server
🔔 code-server is a free browser-based IDE while Coder, is our enterprise developer workspace platform. For more information, visit Coder.com

Requirements

See requirements for minimum specs, as well as instructions on how to set up a Google VM on which you can install code-server.

TL;DR: Linux machine with WebSockets enabled, 1 GB RAM, and 2 CPUs

Getting started

There are three ways to get started:

  1. Using the install script, which automates most of the process. The script uses the system package manager if possible.
  2. Manually installing code-server
  3. Using our one-click buttons and guides to deploy code-server to a cloud provider

If you use the install script, you can preview what occurs during the install process:

curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run

To install, run:

curl -fsSL https://code-server.dev/install.sh | sh

When done, the install script prints out instructions for running and starting code-server.

We also have an in-depth setup and configuration guide.

Questions?

See answers to frequently asked questions.

Want to help?

See Contributing for details.

Hiring

Interested in working at Coder? Check out our open positions!

For Organizations

Want remote development for your organization or enterprise? Visit our website to learn more about Coder.