Skip to content

Commit 15beb98

Browse files
authored
docs: Add additional commands (coder#455)
This adds a couple of missing pieces to the docs: - More info about `./develop.sh` - Steps to run the built coder binary manually - Starting the server - Logging in - Creating a project I attempted to keep them relatively agnostic so they wouldn't be out of date immediately when coder#422 is merged
1 parent 548b4f2 commit 15beb98

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,33 @@ This repository contains source code for Coder V2. Additional documentation:
3535

3636
The `coder` CLI binary will now be available at `$GOPATH/bin/coder`
3737

38+
### Running
39+
40+
After building, the binaries will be available at:
41+
- `dist/coder_{os}_{arch}/coder`
42+
43+
For the purpose of these steps, an OS of `linux` and an arch of `amd64` is assumed.
44+
45+
To manually run the server and go through first-time set up, run the following commands in separate terminals:
46+
- `dist/coder_linux_amd64/coder daemon` <-- starts the Coder server on port 3000
47+
- `dist/coder_linux_amd64/coder login http://localhost:3000` <-- runs through first-time setup, creating a user and org
48+
49+
You'll now be able to login and access the server.
50+
51+
To create a project, run:
52+
- `dist/coder_linux_amd64/coder projects create -d /path/to/project`
53+
3854
### Development
3955

4056
- `./develop.sh`
4157

42-
The `develop.sh` script runs the server locally on port `3000`, and runs a hot-reload server for front-end code on `8080`.
58+
The `develop.sh` script does three things:
59+
60+
- runs `coder daemon` locally on port `3000`
61+
- runs `webpack-dev-server` on port `8080`
62+
- sets up an initial user and organization
63+
64+
This is the recommend flow for working on the front-end, as hot-reload is set up as part of the webpack config.
4365

4466
## Front-End Plan
4567

0 commit comments

Comments
 (0)