https://github.com/o4epegb/dcss-stats

DCSS stats frontend repo
https://github.com/o4epegb/dcss-stats

dcss dungeon-crawl-stone-soup

Last synced: 3 months ago
JSON representation

DCSS stats frontend repo

• Host: GitHub
• URL: https://github.com/o4epegb/dcss-stats
• Owner: O4epegb
• Created: 2021-07-30T21:11:49.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-02-12T22:33:11.000Z (11 months ago)
• Last Synced: 2024-04-13T20:33:27.844Z (9 months ago)
• Topics: dcss, dungeon-crawl-stone-soup
• Language: TypeScript
• Homepage: https://dcss-stats.vercel.app
• Size: 2.4 MB
• Stars: 7
• Watchers: 2
• Forks: 2
• Open Issues: 0
• 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 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 (if not using `yarn bootstrap`)

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 `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`:

```yml

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

```

Then run frontend with:

```sh

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

```

### Backend

Start Postgres with Docker Compose:

```sh

yarn workspace @dcss-stats/api compose

```

Run backend with:

```sh

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.