Dungeon Crawl Stone Soup statistics app.
- Node.js
- Yarn
- (for the BE) Docker Compose or local Postgres database
yarn install && yarn bootstrapIt will install all npm dependencies, run Postgres with Docker Compose and create seeded database.
yarn devIt will start both frontend and backend in development mode.
This is a yarn monorepo, so you need to install packages in the root folder with:
yarn installUse yarn to install, other package managers are not recommended.
If you want to update package versions use:
yarn upgrade-interactiveIf you only want to run frontend, create .env.local file in apps/web folder if it doesn't exist and add:
NEXT_PUBLIC_ROOT_URL="https://dcss-stats.com"Then run frontend with:
yarn dev:webStart Postgres with Docker Compose:
yarn workspace @dcss-stats/api composeIf you want to run backend with different Postgres database, you can change DATABASE_URL env variable in .env.local file (create it if it doesn't exist in apps/api folder):
DATABASE_URL='postgresql://postgres:postgres@localhost:5432/dcssstats'Then you can run migrations and seed the database:
yarn migrateRun only the backend with:
yarn dev:apiIf you want to change some environment variables only for your local development then you need to make a .env.local file. Check other .env* files or search for NEXT_PUBLIC_ to see what variables are being used.