README.md

Description

This app manages your tournaments and generates the schedules.

Documentation

The API documentation is generated with Swagger. API Documnentation

Installation

We recommand using Homebrew on your MAC or chocco on windows.

Install the following prerequisites with brew

# install NodeJS
brew install node

# install yarn
brew install yarn

# install mysql database
brew install mysql

Now we can install our dependencies with the following command.

$ yarn install

Create your .ENV file

Copy the .env.examle and rename it to .env. In this file collects all the global configurations.

Database setup

Create a database with the name copa. Then run yarn run db:setup. This will migrate the database and seed some data into it.

Mail setup

Change the vairables in the .env to correct mail server and user credentials.

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Testing the app

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov