Project Setup

You may choose Docker-compose(recommended), or Through virtual env

Through Docker[Recommended]

• Prerequisite - Docker

After forking the repository

to build:

docker-compose build

or

make build

to run:

docker-compose up

or

make up

• Visit http://127.0.0.1/ with the endpoints or /docs for documentation

Through virtual env

• Prerequisite
  • Python
  • use a git bash console to run the commands below
• After forking the repository
• Create virtual env
• Activate you virtual environment . path/to/virtualenv/bin/activate
• Install requirements.txt

  pip install -r requirements.txt
  

• Load the environment variables: . load_env.sh
• Now you ready to runserver.

  uvicorn app.main:app --reload
  

• Checkout your local host http://127.0.0.1:8000/ with the endpoints or /docs for documentation