Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
62 lines (41 loc) · 1.13 KB

DEVELOPMENT.md

File metadata and controls

62 lines (41 loc) · 1.13 KB

Requirements

  • Docker and Docker Compose v2

Development (Docker)

  1. Clone the repo:
git clone https://github.com/OneBacklog/Arctic
cd Arctic
  1. Generate secrets and create data folders:
APP_ENV=development bash setup.sh
  1. Start the services:
docker compose -f compose.dev.yaml up -d --build

The app will run at http://localhost:3000 with hot reload on app/ and server/.

  1. After the app is running, generate your OTP secret:
docker compose -f compose.dev.yaml run --rm setup-auth
  1. Reset the OTP secret (generates a new key) if somehow you lose it:
docker compose -f compose.dev.yaml run --rm -e RESET=1 setup-auth

Common Commands

docker compose -f compose.dev.yaml restart app
docker compose -f compose.dev.yaml logs -f app
docker compose -f compose.dev.yaml down

Database Migrations

Migrations in server/database/migrations/ run automatically on startup.

Generate a migration after editing server/database/schema.ts:

npx drizzle-kit generate --name=<migration-name>

Open the DB inspector:

npx drizzle-kit studio