Be sure to use the same version of the code as the version of the docs you're reading. You probably want the latest tagged version, but the default Git version is the master branch.

# clone the repository
git clone https://github.com/ruankosu/CS467-Cassiopeia
cd CS467-Cassiopeia

Create a virtualenv and activate it:

python3 -m venv venv
. venv/bin/activate

Or on Windows cmd:

py -3 -m venv venv
venv\Scripts\activate.bat

Install requirements:

pip install -r requirements.txt

export FLASK_APP=cassiopeia
export FLASK_ENV=development
flask run

Or on Windows cmd:

set FLASK_APP=cassiopeia
flask run

Open http://127.0.0.1:5000 in a browser.

pip install '.[test]'
pytest

Run with coverage report:

coverage run -m pytest
coverage report
coverage html  # open htmlcov/index.html in a browser