Portal is a cross-platform application, supporting Linux, Mac and Windows.

Portal can either be installed as a Web Application or from an Executable file. The below will show the procedures for both methods:

  1. Running Portal as a Web Application
  2. Running Portal from Portal Executable

Running Portal as a Web Application

Before beginning this method, please ensure that you have python 3.7 (or up). There are 2 ways to do this. Firstly, clone the repository. Next, navigate to the directory where requirements.txt is located and install all necessary dependencies:

git clone
cd portal
pip install -r requirements.txt

Running the following command opens the Portal application your browser via http://localhost:9449.



If you wish to run the application on your graphics card, add the --gpu flag.

Using Virtual Environments

If you'd like to use virtual environments for this project, you can use this helpful script (instead of ./ which installs dependencies globally)



If you have installed the packages in a virtual environment, you must activate it before running the application.

Running Portal from Portal Executable

Portal comes with an installable version that runs on electron.js - this helps to provide a desktop application feel and easy plug-and-play installation.

To install Portal using this method, please download the latest version from Github Releases. Download the Installer according to your Operating System and run the installer.