Skip to main content

Using python

What you'll need

  • Please ensure you have Python installed. The tool supports Python version 3.10.

Getting started


👉 Step #1 - Clone our repository which includes the code using the following command:

git clone git@github.com:PerForge/PerForge.git

👉 Step #2 - Create a virtual environment

# Virtualenv modules installation (Unix based systems)
virtualenv env
source env/bin/activate

# Virtualenv modules installation (Windows based systems)
# pip install virtualenv
# virtualenv env
# .\env\Scripts\activate

👉 Step #3 - Install dependencies

# Install requirements
pip3 install -r requirements.txt

👉 Step #4 - Set Up Environment

# Set the FLASK_APP environment variable
(Unix/Mac) export FLASK_APP=run.py
(Windows) set FLASK_APP=run.py
(Powershell) $env:FLASK_APP = ".\run.py"

👉 Step #5 - Start the project

# Run the application
flask run --host=0.0.0.0 --port=5000