Expense tracking for individuals.
- Node.js (version specified in
.nvmrc
)- Use
fnm
for Node.js version management. It will automatically use the correct version of Node.js when youcd
into the project directory.
- Use
- Yarn
- Docker and Docker Compose (for local Postgres database)
- Or compatible alternative (e.g. Podman)
- Copy
.env.example
to.env
and fill in the values. The defaults should work for local development. - Install dependencies:
yarn
- Start local PostgreSQL:
yarn infra:up
- Run migrations:
yarn db:migrate
- Previous step should automatically generate the database client, but if it didn't, generate it manually with
yarn db:generate-client
.
Remember to run migrations and / or generate the database client when the database schema changes.
- Start local PostgreSQL:
yarn infra:up
- Start the backend server:
yarn backend:start
- Start the frontend dev server:
yarn frontend:start
- Open http://localhost:1234 in your browser
Backend is automatically restarted on changes. Frontend will hot reload on changes.
- Run
docker compose -f saituri-compose.yaml up
- The server should now be running on http://localhost:3001.
You can use /api/health
for health checks.