readme.md

Full API documentation can be found here

You might want to install these softwares:

• sqlitebrowser - to view sqlite files.

  sudo apt-get install sqlitebrowser
  

Server-side installation guide

On Linux:

Environment

0. Browse to server folder.

1. Create venv:

   python3 venv venv
   

   Running:

   . venv/bin/activate
   

   To stop:

   deactivate
   

2. Install required packages:

   pip install -r requirements.txt
   

3. Setting up environment variables

   export FLASK_APP=serverside
   export FLASK_ENV=development
   

4. Run server.

   flask run
   

   or, a shortcut for those steps:

   ./run_server.sh
   

Database creation

Repeat from Environment's step 1 to step 3, then type this to the terminal:

flask init-db

or,

./init_db.sh

On Windows:

Environment:

0. Browse to server folder.

1. Create venv

   python -m venv venv
   

   Activate:

   venv\Scripts\activate
   

   To stop:

   deactivate
   

2. Install required packages

   From inside venv, run pip install.

   pip install -r requirements.txt
   

3. Setting up environment variables

   set FLASK_APP=serverside
   set FLASK_ENV=development
   

4. Run server.

   flask run
   

Database creation

Repeat from Environment's step 1 to step 3, then type this to the terminal:

flask init-db