Skip to content

Development

Jump to bottom
mcinquin edited this page Oct 12, 2026 · 1 revision

Development

Requirements

  • Node.js 24 (see .nvmrc)
  • npm

Local setup

cp .env.example .env.local
# Set AUTH_SECRET in .env.local (openssl rand -hex 32)
npm ci
npm run dev

The application is available at http://localhost:3000.

On first launch, create the administrator account from the login screen (bootstrap).

Useful scripts

npm run ci         # fast local checks (recommended before pushing)
npm run ci:full    # lint + typecheck + npm audit high+ (used by GitHub Actions)
npm run check      # alias for npm run ci
npm run lint
npm run typecheck
npm run build
npm start
npm test           # Vitest unit tests
npm run clean      # removes .next, TypeScript caches, etc.

Code quality

  • npm run ci: local checks without network dependency (Node, lint, typecheck, tests)
  • npm run test: Vitest unit tests (auth, CSRF, collection query, card CRUD)
  • npm run ci:full: GitHub Actions checks with npm audit high+
  • Husky: pre-commit (ESLint on staged files), pre-push (npm run ci), commit-msg (commitlint conventional)
  • Dependabot: weekly npm and GitHub Actions updates

Contribution flow

See CI-and-releases for Conventional Commits, PR squash-merge, and semantic-release.

Related

Clone this wiki locally