Local Run Instructions

Clone the project and run the following commands in the terminal

python -m venv venv 

Activate the virtual environment

source venv/bin/activate OR .\venv\Scripts\activate

Install Dependencies

pip install -r requirements.txt 

Seed Database

flask db seed 

Run the App

flask run

We can now access and perform actions via

127.0.0.1:5000/swagger-ui

One-liner Docker instruction

The below command will start two containers one for flask and another for mysql, It will also populate the database in the container. Please check 127.0.0.1:5005/swagger-ui after the containers have started.

docker-compose up

Side Note

• User creation Flow : Create User, Create User Contact , Create User Role
• For authentication through Swagger UI, place the jwt token inside the auth box without quotes

Notes

For any further data modification, please add or change data inside either JSON

sample.json

OR

Database

seeds.py

Project Sample