Skip to main content

Deployment

This document serves as a guide that offers instructions to deploying SCHEMA api, on different deployment use cases. In order for SCHEMA api to work, ensure that all of SCHEMA api's dependencies are satisfied.

Install locally​

In order to install SCHEMA api locally, it is required that Python 3.11 is installed. In addition, to avoid package collisions, it is recommended that a virtual environment solution like Pipenv or virtualenv is used.

  1. Clone code from Github
  2. Install dependencies
    • For Pipenv you may use:
      pipenv install
    • For pip, you can use:
      pip install -r requirements.txt
  3. Define configuration variables
  4. Generate and perform initial migrations
    python manage.py makemigrations
    python manage.py migrate
  5. Run server
    python manage.py runserver