[Project name]

[About the project]

Getting Started

After cloning, run these once to set up your environment:

npm i                            # install dependencies
npx playwright install chromium  # Chromium for Vitest component tests + Playwright E2E
npm install -g hasura-cli        # Hasura CLI for migrations, metadata, console

Also install a Docker runtime if you don't have one — see hasura/README.md for platform-specific instructions (Colima on Mac, Rancher Desktop on Windows, Docker Engine on Linux).

Start the backend before running npm run dev — codegen connects to Hasura at startup.

Developing

npm run dev        # runs GraphQL codegen, then starts vite dev server
npm run generate   # GraphQL codegen only (run after editing documents.ts)

Building & Deploying

npm run build      # production vite build
npm run preview    # preview the production build locally
npm run b          # build + package into deploy.tar.gz for Docker/CapRover

Testing

npm run test                # all unit + e2e tests
npm run test:unit           # vitest — Svelte component tests (browser/chromium)
npm run test:unit:server    # vitest — server-side/API tests (node)
npm run test:unit:ui        # vitest with interactive UI
npm run test:e2e            # Playwright headless
npm run test:e2e:ui         # Playwright interactive UI
npm run test:h              # Playwright headed, single worker (debug mode)

Type Checking

npm run check        # full type-check
npm run check:watch  # type-check in watch mode

Maintenance

npm run cu     # clean reinstall (Unix)
npm run cw     # clean reinstall (Windows)
npm run i-npm  # update npm globally to latest version

Setting up Backend in Local

• Set up .env secrets with command cp .env.example .env and then open and edit the .env - set strong passwords there and for the AUTH_SECRET you need to generate a random 32bit hex eg. like this openssl rand -hex 32 or here.

• Now go to hasura folder and set up secrets there, too:

  chmod +x be.sh
  cd hasura
  cp .env.example .env
  cp config.example.yaml config.yaml
  

  And update now also here in hasura folder the .env and config.yaml files.

• Start your Docker runtime (see hasura/README.md for platform-specific instructions) and then start the backend containers: docker-compose up -d and you shall see now:

[+] Running 2/2 ✔ Container hasura-postgres-1 Healthy ✔ Container hasura-graphql-engine-1 Started

AI Tooling

This project is configured for Claude Code (and compatible with other AI agents).

Slash commands (inside Claude Code sessions):

See shell-aliases.md for setup instructions.