readme.md

Name of Project

• description

Required Features

Additional Features

Prerequisite

• Python3.6
• Virtual Environment
• Flask
• Flask-RESTful

Technologies & Languages

Project management (Agile) https://www.pivotaltracker.com

Version control (Git) https://git-scm.com/

Version control (Flask) https://flask.palletsprojects.com/en/1.1.x/

Version control (Python) https://www.python.org/

Installation and Setup

Clone the repository below

git clone https://github.com/{username}/{repo_name}.git

Create and activate a virtual environment

virtualenv venv --python=python3.6

source venv/bin/activate

Install required Dependencies

pip install -r requirements.txt

Copy environment variable

cp env.sample .env

Load/refresh .environment variables

source .env

Running the application

python manage.py server

Endpoints Available

• update your available endpoints

Method	Endpoint	Description	Roles
POST	/auth/signup	sign up a user	users
POST	/auth/login	log in a user	users

License

MIT