Archived
1
0
This repository has been archived on 2024-09-09. You can view files and clone it, but cannot push or open issues or pull requests.
code-server/docs
Joe Previte c51ff3bce1
refactor: move integration tests to Jest (#5275)
* feat: add installExtension integration test

This adds a new helper function called `runCodeServerCommand` along with
a test for `--install-extension`. We can use this approach for writing
integration tests (i.e. testing a real code-server build, CLI commands,
etc).

* refactor: s/ test:standalone with test:integration

This replaces our integration approach to use Jest instead of a single
bash script. By doing this, we will be able to easily maintain and add
to our integration test suite.

* refactor: filter unit tests

Now that our integration tests also use Jest, we need to update our unit
test script to ignore `test/integration`.

* refactor: add SKIP_SUBMODULE_DEPS to postinstall

* refactor: add SKIP_SUBMODULE_DEPS to postinstall

* fixup!: skip submod deps

* refactor: move runCodeServerCommand into sep. file

When Jest runs a test, it loads all the files and imports for that test.
This means you might be "requiring" code that's unrelated to your tests.

This leads to unexpected errors depending on where the code runs.

Moved this file to avoid GLIBC and other errors relaed to argon2 when
running integration tests in CI.

* fizup: formatting

* fizup: increase timeout

* refactor: use fixture in installExtension test

Instead of relying on a network to install an extension, we use a
fixture - vsix file in the repo. This is also faster.

* feat: add integration test for listExtensions

* chore: ignore integration fixtures

* fixup: formatting

* fixup: remove custom-hacks.css

* fixup: formatting

* Update test/integration/installExtension.test.ts

Co-authored-by: Asher <ash@coder.com>

* Update test/integration/listExtensions.test.ts

Co-authored-by: Asher <ash@coder.com>

* Update test/integration/installExtension.test.ts

Co-authored-by: Asher <ash@coder.com>

* Update test/integration/listExtensions.test.ts

Co-authored-by: Asher <ash@coder.com>

* fixup: contributing integration tests section

* fixup: update ci/readme

* fixup: use RELEASE_PATH in test-integration.sh

* refactor: unzip vsix for listExtensions

* refactor: use exec instead of spawn

* Update docs/CONTRIBUTING.md

Co-authored-by: Asher <ash@coder.com>

* Update test/integration/listExtensions.test.ts

Co-authored-by: Asher <ash@coder.com>

* Update test/integration/listExtensions.test.ts

Co-authored-by: Asher <ash@coder.com>

* Update test/integration/listExtensions.test.ts

Co-authored-by: Asher <ash@coder.com>

* refactor: use different default binary path

* fixup!: formatting

Co-authored-by: Asher <ash@coder.com>
2022-06-24 16:33:38 +00:00
..
assets fix(docs): use png screenshot instead of svg 2021-09-09 17:58:17 -07:00
android.md chore: upgrade Code to 1.66 (#5135) 2022-05-04 21:58:49 +00:00
CODE_OF_CONDUCT.md Update docs/CODE_OF_CONDUCT.md 2021-02-03 11:08:06 -07:00
collaboration.md release: 4.4.0 (#5169) 2022-05-06 13:45:49 -07:00
CONTRIBUTING.md refactor: move integration tests to Jest (#5275) 2022-06-24 16:33:38 +00:00
FAQ.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
guide.md Fix caddy installation docs (#5209) 2022-05-19 22:36:06 +00:00
helm.md release: 4.4.0 (#5169) 2022-05-06 13:45:49 -07:00
install.md revert(docs): partially revert 326a1d1862 (#5095) 2022-04-13 17:15:21 +00:00
ios.md Update ios.md (#5079) 2022-04-12 11:32:49 -07:00
ipad.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
link.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
MAINTAINING.md release: 4.4.0 (#5169) 2022-05-06 13:45:49 -07:00
manifest.json release: 4.4.0 (#5169) 2022-05-06 13:45:49 -07:00
npm.md chore: upgrade Code to 1.66 (#5135) 2022-05-04 21:58:49 +00:00
README.md chore: update Coder messaging on README (#5268) 2022-06-15 09:49:49 -05:00
requirements.md Update requirements.md (#4882) 2022-02-18 11:06:58 -07:00
SECURITY.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
termux.md docs: simplify termux installation process (#5078) 2022-04-12 15:42:22 -07:00
triage.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
upgrade.md refactor(docs): clean up and restructure 2021-07-12 14:03:09 -05:00

code-server

"GitHub Discussions" "Join us on Slack" Twitter Follow codecov See latest

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

Note

To manage multiple IDEs, workspaces, and teams, see our new project: coder/coder

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.