TourneyGen

What is TourneyGen? It is primarily a league management service. What does that mean? Well basically, if you are in charge of a league (sports, e-sports, etc), then you can use our website to effectively manage the teams and tournaments hosted within your league! Sign up at TourneyGen's website

Development Instructions

Please note, these instructions are still a work-in-progress and as such are very volatile.

First time setup

Upon cloning the repo, you first need to install the requirements, and setup pre-commit on your machine.

Project requirements

In order to even run the project, you must have both docker/docker-compose, and npm version 6.12.0 installed.

To install docker

on linux:

sudo snap install docker

on mac:

brew install docker
brew install docker-compose

To install npm

on linux:

curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
sudo apt-get install -y nodejs
sudo npm install npm -g

on mac:

brew install npm
sudo npm install -g npm@latest

Requirements

This project uses npm for package management, and as such, running

npm install

will automatically install your requirements.

Precommit tools

A linter has been added to the repository. It will fix any formatting issue in Typescript when a commit is made.

Building the project

Thanks to the magic of Docker, building the project manually is no longer necessary. Docker will do all of the building automagically when you run

sudo-docker-compose build

Starting the Server

In order to build the server images run this should only be done if there are changes to the compose file or the Dockerfile. If you setup docker differently than is set out in this document, then you may not need to use sudo.

If this is your first time running the docker you must create a docker volume for the mongodb.

docker volume create mongoData

In order to start the Server run. The output will be the port the backend is running on.

sudo docker-compose up

Alternatively, to both build and start the server in one, run

sudo docker-compose up --build

Docker controls both the front and the backend. If you would like to connect directly to the backend then connect to localhost:34345. To connect to the frontend, connect to localhost:34346.