beating.games

beating.games is a beautiful way to organize your video game backlog.

Local setup

Requirements

Node 18 or higher

Prisma supported DB server (PostgreSQL, MySQL, SQL Server, SQLite, MongoDB and CockroachDB)

Instructions

Clone the repo

## install server dependencies
yarn # (--ignore-engines if using yarn 1.x)

## setup .env
cp .env.sample .env # adjust it accordingly, make sure to create folders for static content and set permissions to the process runner

## run db migrations
npx prisma migrate deploy

## start server
yarn dev

## setup client
cd client

## setup .env
cp .env.sample .env # adjust it accordingly

# install dependencies
yarn

# start client server
yarn dev

Generating API client for frontend

Interfaces, service methods and hooks are automatically generated from the OpenAPI specification provided by the API.

To regenerate after changes to the API, run yarn generate-api.

Deploying

To deploy the app to be used in production you need to build the server and client.

A basic deployment pipeline would include:

# in a temporary working directory

## install server dependencies 
yarn # (--ignore-scripts if yarn 1.x)
# run db deployments
npx prisma migrate
# make sure new prisma types are generated
npx prisma generate
# build dist
yarn build

# build client
cd client
yarn
yarn build

# package everything
cd ..
mkdir package
cp dist package
cp client package

# deploy your package, stop services, whatever you need to do, copy the package and run it with `node dist/main`, preferably as a service