Skip to content
Open
Changes from all commits
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
28 changes: 28 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,34 @@ make test-frontend # type check and Vitest
make test # both
```

## Troubleshooting

### Port 3000 or 8000 is already in use

Stop the process that is using the port, or change the published port in `docker-compose.yml`, for example `"3001:3000"`. To find out what is listening on a port, run `lsof -i :3000` for the frontend or `lsof -i :8000` for the backend.

### The frontend shows an API error

The frontend could not reach the backend. Check that the backend is running and healthy:

```bash
curl http://localhost:8000/api/health
```

If you run the frontend with `npm run dev`, the backend must listen on port 8000, because Vite proxies `/api` requests there.

### Browser requests fail with a CORS error

Add the origin the frontend is served from to `CORS_ORIGINS`. See [configuration](configuration.md) for the format.

### Start again with an empty database

Stop the app and delete the SQLite file. With the default configuration and a local run, that is `backend/todos.db`. If you changed `DATABASE_URL`, delete the file it points to instead. With Docker Compose, remove the containers and their volumes:

```bash
docker compose down -v
```

## Next steps

- Browse the [API reference](api-reference.md) to see every endpoint.
Expand Down
Loading