If you have Docker or Rancher installed, you can skip to this section. If you only want to run the project on your own machine, just skip to this section. If you want to build and run the project from scratch on your own machine, well, there's a bit of reading, and it starts now.

• Clone, or download + extract this project
• For NodeJS installation, consult the following link

Once done, open a new terminal in the directory pySET and type the following commands to build the WebUI.

cd pySET/flask
npm install
npm run generate

In this section, I will assume that you either followed the building instructions above, or downloaded and extracted the latest release.

• For Python 3 installation, consult the following link

Once done, open a new terminal in the directory pySET and type the following command to create the python virtual environment.

python -m venv .venv

In the same terminal, activate the .venv previously created as follow, or as shown in HowTo, and install the project's dependencies.

• Windows

.venv\Scripts\activate
pip install -U -r requirements.txt

• Unix or MacOS

source .venv/bin/activate
pip install -U -r requirements.txt

Once done, you can run the project with either

python server_app.py -c config.json

or

gunicorn -c gunicorn/dev_app.py

You can now open your favorite web browser and start-the-game

I wrote a Dockerfile as a training exercise and for those that want something that "just works". (Though, you have to know how Docker or Rancher works beforehand...)

cd pySET
docker build -t pyset:0.2 .
docker run -d -p 10000:10000 pyset:0.2