oumao / fast-food-api-v2 Goto Github PK

Fast-Food-Fast is a food delivery service app for a restaurant. and this is the API(backed) for the app

• Python3 (A programming language)
• Flask (A Python microframework)
• PostgreSQL (Database)
• Virtualenv (Stores all dependencies used in the project)
• Pivotal Tracker (A project management tool)
• Pytest (Framework for testing)

• Flask_restful
• Postman
• Psycopg2

The API is hosted here

To start this app, please follow the instructions below:

On your terminal:

Install pip:

$ sudo apt-get install python-pip

Clone this repository:

$ git clone https://github.com/SilasKenneth/fast-food-api-v2.git

Get into the root directory:

$ cd fast-food-api-v2

Install virtualenv:

$ pip install virtualenv

Create a virtual environment in the root directory:

$ virtualenv name of virtualenv

Note: If you do not have python3 installed globally, please run this command when creating a virtual environment:

$ virtualenv -p python3 -name of virtualenv-

Activate the virtualenv:

$ source name of virtualenv/bin/activate

Install the requirements of the project from the requirements file:

$ pip install -r requirements.txt

Create two databases, one for testing environment and one for development envronnment,as follows:

$ createdb fast_food

$ createdb testdb

To run tests:

$ pytest

To run the app:

$ Python run.py