kushalkanavi / flask_assignment

Install Virtual Environment

- virtualenv <envname> --python=python3
    - type this command to create a virtual environment, where envname can be any name chosen by user.
- To Activate Virtual Environment
    - source envname/bin/activate
- To Deactivate Virtual Environment
    - deactivate

Instal required libraries from requirements.txt

To Install type this command.
- pip install -r requirements.txt    

To create Tables

In Terminal or command prompt
- python3
>>> from app import db
>>> db.create_all()
>>> exit()

For running Flask Server

Go to flask_backend folder.
    - python app.py

For Api

    - Goto Browser/postman and type : http://localhost:5000/

For Docker

Go to flask_backend folder.
    - docker-compose up

For API Documentation

Api Documentation can be found in, after runnning the Flask Server
    - http://localhost:5000/swagger/