DCSS Stats

Dungeon Crawl Stone Soup statistics app.

Prerequisites

• Node.js
• Yarn
• (for the BE) Docker Compose or local Postgres database

Bootstrap local development

yarn bootstrap

It will install all npm dependencies, run Postgres with Docker Compose and create seeded database.

Run development mode

yarn dev

It will start both frontend and backend in development mode.

Install packages (if not using yarn bootstrap)

This is a yarn monorepo, so you need to install packages in the root folder with:

yarn install

Use yarn to install, other package managers are not recommended.

If you want to update package versions use yarn upgrade-interactive

Frontend

If you only want to run frontend, point NEXT_PUBLIC_ROOT_URL env variable to the production backend at https://dcss-stats.com:

NEXT_PUBLIC_ROOT_URL="https://dcss-stats.com"

Then run frontend with:

yarn dev --filter=@dcss-stats/web

Backend

Start Postgres with Docker Compose:

yarn workspace @dcss-stats/api compose

Run backend with:

yarn dev --filter=@dcss-stats/api

Environment variables

If you want to change some environment variables only for your local development then you need to make .env.local file. Check other .env* files or search for NEXT_PUBLIC_ to see what variables are being used.