8000 docs: add backend contributing guide by mtojek · Pull Request #18077 · coder/coder · GitHub
[go: up one dir, main page]

Skip to content

docs: add backend contributing guide #18077

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.

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

Merged
merged 32 commits into from
May 30, 2025
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
PR comments
  • Loading branch information
mtojek committed May 29, 2025
commit 253c4466549f93e595d03ebba234d0daf44e8bfc
8 changes: 5 additions & 3 deletions docs/contributing/backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Need help or have questions? Join the conversation on our [Discord server](https

## Quickstart

To get up and running with Coder's backend, make sure you have **Docker installed and running** on your system. Once that's in place, follow these steps:
To get started with Coder's backend, the easiest way to set up the required environment is to use the provided [Nix environment](https://github.com/coder/coder/tree/main/nix) or launch a local [DevContainer](https://github.com/coder/coder/tree/main/.devcontainer). Alternatively, ensure you have the following installed and running on your system: **Docker, Go, Node.js (with pnpm), and make**.

Once that's in place, follow these steps:

1. Clone the Coder repository and navigate into the project directory:

Expand All @@ -33,8 +35,8 @@ cd coder

This will start two processes:

* http://localhost:3000 — the backend API server, used primarily for backend development.
* http://localhost:8080 — the Node.js frontend dev server, useful if you're also touching frontend code.
* http://localhost:3000 — the backend API server. Primarily used for backend development and also serves the *static* frontend build.
* http://localhost:8080 — the Node.js frontend development server. Supports *hot reloading* and is useful if you're working on the frontend as well.

1. Verify Your Session

Expand Down
Loading
0