Skip to content

Commit 54bbed8

Browse files
chore: Fix default password and add more docs about scripts/develop.sh (#6514)
1 parent 7df1e3b commit 54bbed8

File tree

3 files changed

+17
-1
lines changed

3 files changed

+17
-1
lines changed

docs/CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,12 @@ Use the following `make` commands and scripts in development:
7373
- `make install` installs binaries to `$GOPATH/bin`
7474
- `make test`
7575

76+
### Running Coder on development mode
77+
78+
- Run `./scripts/develop.sh`
79+
- Access `http://localhost:8080`
80+
- The default user is `admin@coder.com` and the default password is `SomeSecurePassword!`
81+
7682
### Adding database migrations and fixtures
7783

7884
#### Database migrations

docs/contributing/frontend.md

+9
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
This is a guide to help the Coder community and also Coder members contribute to our UI. It is ongoing work but we hope it provides some useful information to get started. If you have any questions or need help, please send us a message on our [Discord server](https://discord.com/invite/coder). We'll be happy to help you.
44

5+
## Running the UI
6+
7+
You can run the UI and access the dashboard in two ways:
8+
9+
- Build the UI pointing to an external Coder server: `CODER_HOST=https://mycoder.com yarn dev` inside of the `site` folder. This is helpful when you are building something in the UI and already have the data on your deployed server.
10+
- Build the entire Coder server + UI locally: `./scripts/develop.sh` in the root folder. It is useful when you have to contribute with features that are not deployed yet or when you have to work on both, frontend and backend.
11+
12+
In both cases, you can access the dashboard on `http://localhost:8080`. If you are running the `./scripts/develop.sh` you can log in using the default credentials: `admin@coder.com` and `SomeSecurePassword!`.
13+
514
## Tech Stack
615

716
All our dependencies are described in `site/package.json` but here are the most important ones:

scripts/develop.sh

+2-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ source "${SCRIPT_DIR}/lib.sh"
1313
[[ -n ${VERBOSE:-} ]] && set -x
1414
set -euo pipefail
1515

16-
password="${CODER_DEV_ADMIN_PASSWORD:-password}"
16+
DEFAULT_PASSWORD="SomeSecurePassword!"
17+
password="${CODER_DEV_ADMIN_PASSWORD:-${DEFAULT_PASSWORD}}"
1718

1819
args="$(getopt -o "" -l agpl,password: -- "$@")"
1920
eval set -- "$args"

0 commit comments

Comments
 (0)