Skip to content

Commit ca13f72

Browse files
authored
docs: simplify quickstart (#1805)
1 parent 3cecf40 commit ca13f72

3 files changed

Lines changed: 11 additions & 27 deletions

File tree

docs/development/local-development.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Compass has multiple workable development modes. Pick the lightest mode that supports the feature you are changing.
44

5+
For first-time setup, see [Development Quickstart](./quickstart.md).
6+
57
## Frontend-Only Mode
68

79
Command:
@@ -19,7 +21,7 @@ Use this for:
1921

2022
You do not need the backend for basic frontend rendering.
2123

22-
## Backend Mode
24+
## Backend
2325

2426
Command:
2527

docs/development/quickstart.md

Lines changed: 7 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,22 @@
44

55
```bash
66
git clone git@github.com:SwitchbackTech/compass.git
7-
87
cd compass
9-
108
bun install
11-
12-
## Setup config values
13-
14-
```bash
15-
cp compass.example.yaml compass.yaml
169
```
1710

18-
Replace the placeholder values in `compass.yaml`
19-
20-
## Run
21-
22-
Run the web app in one terminal:
11+
## Run the web app
2312

2413
```bash
2514
bun run dev:web
26-
# Frontend on <http://localhost:9080>
2715
```
2816

29-
Run the backend in another terminal:
30-
31-
```bash
32-
bun run dev:backend
33-
# Backend on <http://localhost:3000>
34-
```
17+
The frontend runs at <http://localhost:9080>.
3518

36-
## Testing
19+
## Backend and config
3720

38-
After making your changes, you can run our test suite locally before opening a PR.
21+
Most frontend work does not need backend services. For backend, auth, MongoDB,
22+
Google sync, SSE, or CLI work, see [Local Development](./local-development.md).
3923

40-
```bash
41-
bun run test:core && bun run test:web && bun run test:backend
42-
bun run test:e2e
43-
```
24+
For test commands and expectations, see the
25+
[Testing Playbook](./testing-playbook.md).

docs/self-hosting/server-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ curl -fsSL https://raw.githubusercontent.com/SwitchbackTech/compass/main/self-ho
149149

150150
If you'd rather do everything yourself, check-out our [manual install guide](https://raw.githubusercontent.com/SwitchbackTech/compass/main/self-host/install-manual.sh), which has bash commands you can individually copy-paste. This'll give you full visibility and control, but will take longer.
151151

152-
## 3. Configure reverse proxy with Caddy
152+
## Configure reverse proxy with Caddy
153153

154154
Now that we have Docker, Caddy, and Compass install, we can wire up the proxy to ensure requests flow through your system smoothly.
155155

0 commit comments

Comments
 (0)