54 lines
750 B
Markdown
54 lines
750 B
Markdown
## Prerequs
|
|
|
|
* Node.js
|
|
* npm
|
|
* Docker + Docker Compose
|
|
|
|
## Installation
|
|
|
|
Install dependencies in each workspace:
|
|
|
|
```
|
|
cd ui && npm install
|
|
cd ../api && npm install
|
|
cd ../shared && npm install
|
|
```
|
|
|
|
## Local Development Setup
|
|
|
|
From the project root, start required services:
|
|
|
|
```
|
|
docker compose -f docker-compose.dev.yml up
|
|
```
|
|
|
|
Run database setup from `/api`:
|
|
|
|
```
|
|
npm run migrate:up
|
|
npm run migrate:seed
|
|
```
|
|
|
|
## Running the App
|
|
|
|
Start the frontend:
|
|
|
|
```
|
|
cd ui
|
|
npm run dev
|
|
```
|
|
|
|
Start the API:
|
|
|
|
```
|
|
cd api
|
|
npm run dev
|
|
```
|
|
|
|
* UI runs via Vite
|
|
* API runs on Node after TypeScript build
|
|
|
|
## Notes
|
|
|
|
* `shared` must have its dependencies installed for both UI and API to work
|
|
* `docker-compose.dev.yml` is required for local dev dependencies (e.g. database) |