https://github.com/o4epegb/dcss-stats
Player and game statistics for open source roguelike game Dungeon Crawl Stone Soup Online
https://github.com/o4epegb/dcss-stats
dcss dungeon-crawl-stone-soup good-first-issue roguelike
Last synced: 4 days ago
JSON representation
Player and game statistics for open source roguelike game Dungeon Crawl Stone Soup Online
- Host: GitHub
- URL: https://github.com/o4epegb/dcss-stats
- Owner: O4epegb
- Created: 2021-07-30T21:11:49.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-05-05T11:22:12.000Z (7 days ago)
- Last Synced: 2025-05-05T12:32:40.855Z (7 days ago)
- Topics: dcss, dungeon-crawl-stone-soup, good-first-issue, roguelike
- Language: TypeScript
- Homepage: https://dcss-stats.com
- Size: 7.08 MB
- Stars: 13
- Watchers: 1
- Forks: 6
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# [DCSS Stats](https://dcss-stats.com/)
[Dungeon Crawl Stone Soup](https://crawl.develz.org/) statistics app.
## Prerequisites
- [Node.js](https://nodejs.org/)
- [Yarn](https://yarnpkg.com/)
- (for the BE) [Docker Compose](https://docs.docker.com/compose/) or local Postgres database
## Bootstrap Local Development
```sh
yarn install && yarn bootstrap
```
It will install all npm dependencies, run Postgres with Docker Compose and create seeded database.
## Run Development Mode
```sh
yarn dev
```
It will start both frontend and backend in development mode.
## Install Packages and Update Versions
This is a `yarn` monorepo, so you need to install packages in the root folder with:
```sh
yarn install
```
Use `yarn` to install, other package managers are not recommended.
If you want to update package versions use:
```sh
yarn upgrade-interactive
```
## Frontend
If you only want to run frontend, create `.env.local` file in `apps/web` folder if it doesn't exist and add:
```yml
NEXT_PUBLIC_ROOT_URL="https://dcss-stats.com"
```
Then run frontend with:
```sh
yarn dev:web
```
## Backend
Start Postgres with Docker Compose:
```sh
yarn workspace @dcss-stats/api compose
```
If 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):
```yml
DATABASE_URL='postgresql://postgres:postgres@localhost:5432/dcssstats'
```
Then you can run migrations and seed the database:
```sh
yarn migrate
```
Run only the backend with:
```sh
yarn dev:api
```
## Environment Variables
If 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.