joaonunomota/circle-of-suck

Circle of Suck visualises the largest chain of negative scorelines for a given season of a competition.

Circle of Suck

Circle of Suck visualises the largest chain of negative scorelines for a given season of a competition.

Development

Requirements

• python 3.11

Project Setup

1. Clone and change to the directory:

   git clone https://github.com/joaonunomota/circle-of-suck.git
   cd circle-of-suck

2. Create and activate a virtual environment:

   Unix based systems:

   virtualenv env
   source env/bin/activate

   Windows:

   python -m venv env
   source env/Scripts/activate

3. Install Python and Node requirements:

   pip install -r requirements.txt

   npm install

4. Add data from football-data.org:

   Fetch data for the desired competitions and seasons.

   python competitions.py update -c <competition> -y <year> -p <path> -t <token>

   Generate an index file once all the data is fetched.

   python competitions.py index -p <path>

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Lint with ESLint

npm run lint