Skip to content

docs(readme): list prerequisites up front and document the seed #55

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.

Sign up for GitHub

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
IBJunior merged 1 commit into from
Oct 30, 2026
Merged

docs(readme): list prerequisites up front and document the seed #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 16 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,19 @@ See [docs/SKILLS.md](docs/SKILLS.md) for the validation rules, the failure polic

## Quick start

### Run it (Docker only)
### Prerequisites

Install these before you start:

**Prerequisites:** Docker, and a model to talk to — an API key for Anthropic, OpenAI or Google, or
any **OpenAI-compatible** endpoint (Ollama, vLLM, LM Studio, Groq, OpenRouter, DeepSeek). A local
runtime needs no key at all; you point Cameron at its base URL in Settings.
- **[Git](https://git-scm.com/downloads)** and **[Docker](https://docs.docker.com/get-docker/)**
with Compose, for either way of running Cameron.
- **A model to talk to**: an API key for Anthropic, OpenAI or Google, or any **OpenAI-compatible**
endpoint (Ollama, vLLM, LM Studio, Groq, OpenRouter, DeepSeek). A local runtime needs no key at
all; you point Cameron at its base URL in Settings.
- **[Node 20+](https://nodejs.org/) and [pnpm](https://pnpm.io/installation)**, only to run the app
on the host. This is also the path that can load sample data.

### Run it (Docker only)

You pick the provider and model **in the app**, not in the environment — with nothing chosen
Cameron says it's unconfigured rather than guessing. `.env` only ever holds the keys.
Expand All @@ -116,8 +124,8 @@ cp .env.example .env # add your model API key, if your provider nee
docker compose --profile full up # http://localhost:3100
```

That builds the app, waits for Postgres, applies migrations, and starts everything. Nothing but
Docker is needed on your machine.
That builds the app, waits for Postgres, applies migrations, and starts everything. Nothing else
is needed on your machine.

> **Why `--branch v4`?** Tags are the stable points — each one matches a published article and has
> passed CI before release. `main` is the working trunk and runs ahead of the latest tag between
Expand All @@ -132,13 +140,14 @@ to that command **deletes your financial data**.

### Work on it (app on the host)

**Prerequisites:** the above, plus Node 20+ and pnpm.
Use this path to change Cameron, or to try it on sample data. From your clone:

```bash
pnpm install
cp .env.example .env # add your model API key, if your provider needs one
docker compose up -d # dev dependencies — Postgres :5544, MinIO :9100/:9101
pnpm db:migrate
pnpm db:seed # optional: sample categories and about six weeks of transactions
pnpm dev # http://localhost:3100
```

Expand Down
Loading