Installation & Setup

To setup the development environment, all required packages must be present.

[Prerequisite] MariaDB

MariaDB is required to run the RESTful application. Installation varies depending on the system on which you plan on hosting the API server. You can read installation instructions on the official guide. The following methods are known to work:

Ubuntu 18.04 LTS

  $ su -
  $ apt-key adv --recv-keys --keyserver hkp://keyserver.ubuntu.com:80 0xF1656F24C74CD1D8
  $ add-apt-repository 'deb [arch=amd64,arm64,ppc64el] http://mirror.rackspace.com/mariadb/repo/10.3/ubuntu bionic main'
  $ apt update
  $ apt install mariadb-server

Arch Linux

  $ su -
  $ pacman -S mariadb
  $ mysql_install_db --user=mysql --basedir=/usr --datadir=/var/lib/mysql
  $ '/usr/bin/mysql_secure_installation'
  $ systemctl start mariadb.service
  $ systemctl enable mariadb.service

macOS and Windows

The setup process on both macOS and Windows is currently not known. If you have contributions for this section, please submit a Pull Request.


To install the all required packages, you can simply run python setup.py. It will automatically check your system environment and install all the necessary Node.js and Python packages.

Node.js Requirements:

Python Requirements:


You can start the frontend or backend servers by changing into the appropriate directory and launching the application with the correct program.