Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.99 KB

README.md

File metadata and controls

81 lines (55 loc) · 2.99 KB

Maintainability Rating Reliability Rating Security Rating

Lines of Code Duplicated Lines (%) Coverage

TWB Logo

Tac-With-Bug is a online Multiplayer for the boardgame TAC. The game is a Vue webapp with a Node backend. Contributions are welcome.

Getting Started Guide

Two step guide to get started with the Tac-With-Bug development.

Database Setup

You will need the CLI for Postgres psql. I also recommend pgAdmin to manipulate the database using a GUI.

  • On Windows install postgres (13.x) locally.

  • On Mac the easiest way is Postgres.app.

  • On Ubuntu you can install the psql CLI only (without the postgres server).

    sudo apt install postgresql-client
    

Start the database with:

docker compose up -d

You can access the database either inside the Docker container or from your system. The postgres password is PGPASSWORD=postgres.

docker exec -it postgres psql
psql -h localhost -U postgres -d tac -c 'INSERT YOUR SQL CODE;'

The database is initialized but not populated. To populate it you can use the test data:

psql -h localhost -U postgres -d tac -f './server/src/dbUtils/populate_test.sql'

Package Setup

Tac-With-Bug is divided into the following parts:

Folder Description
client Vue source code for the web interface
server Node server code

First all packages have to be installed and built.

cd client
npm install

cd server
npm install
npm run build-spec
npm run tsc

Afterwards you can start the server and client.

cd server
npm run start:dev
cd client
npm run dev