Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.02 KB

README.md

File metadata and controls

83 lines (52 loc) · 2.02 KB
Raw

schnoz

schnoz is an online puzzle game where two players place units to score points.

Apps and Packages

  • server: a Nest.js app
  • web: a Next.js app
  • coordinate-utils: util function to interact with coordinates as used in the game
  • game-logic: contains game logic such as game modes, placement rules and more
  • types: all shared types, i.e. database types
  • eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • tsconfig: tsconfig.jsons used throughout the monorepo

Develop

Development database

To spin up a database for development spin up a docker container.

Before serving the database, make sure you have the correct environment variables set in your .env. Use the contents of packages/database/.env.local into packages/database/.env or use the command:

cp packages/database/.env.local packages/database/.env
yarn start:db

To develop all apps and packages, run the following command:

yarn dev

Docker

To run a dockerized version of schnoz you can spawn server, web and database containers using docker-compose.

Create .env

First, create an .env file in the database package with the connection string for the database. Depending on your environment, different values should be used:

With local database

Use the contents of packages/database/.env.docker.local into packages/database/.env or use the command:

cp packages/database/.env.docker.local packages/database/.env

Development-Environment

TBD

Staging-Environment

TBD

Production-Environment

TBD

Build docker images

A docker network is required for the containers to communicate. Create one, if you did not already:

docker network create app_network

Build docker images

COMPOSE_DOCKER_CLI_BUILD=1 DOCKER_BUILDKIT=1 docker-compose -f docker-compose.yml build

Run docker images

docker-compose -f docker-compose.yml up -d