The FOMO Back End repository is a RESTful API built using Python and the framework Flask.
The hosted version can be viewed [here] (https://fomo-api.herokuapp.com/)
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
In order to run this project, the following dependencies will need to be installed:
| Dependency | Version |
|---|---|
| aniso8601 | 8.0.0 |
| attrs | 19.3.0 |
| Click | 7.0 |
| Flask | 1.1.1 |
| Flask-Cors | 3.0.8 |
| Flask-JWT | 0.3.2 |
| Flask-JWT- | |
| Extended | 3.24.1 |
| Flask-RESTful | 0.3.7 |
| Flask- | |
| SQLAlchemy | 2.4.1 |
| gunicorn | 20.0.4 |
| importlib- | |
| metadata | 1.4.0 |
| itsdangerous | 1.1.0 |
| Jinja2 | 2.10.3 |
| MarkupSafe | 1.1.1 |
| more-itertools | 8.1.0 |
| packaging | 20.0 |
| passlib | 1.7.2 |
| pluggy | 0.13.1 |
| psycopg2 | 2.8.4 |
| py | 1.8.1 |
| PyJWT | 1.7.1 |
| pyparsing | 2.4.6 |
| pytest | 5.3.2 |
| pytz | 2019.3 |
| six | 1.13.0 |
| SQLAlchemy | 1.3.12 |
| wcwidth | 0.1.8 |
| Werkzeug | 0.16.0 |
| zipp | 0.6.0 |
This section details the steps to get the development environment up and running.
Step 1: Clone the repository with the command:
$ git clone https://github.com/Baileex/BE-FOMO.git
Step 2: Open the repository in your preferred code editor e.g VSCode, Atom etc
Step 3: Navigate into the cloned repository and create a virtual environment:
virtualenv venv
Step 4: activate the virtual environment
On Mac OS
source venv/bin/activate
Step 5: Install dependencies using the following command:
pip install -r requirements.txt
Providing you have accurately followed the above steps, the repository will be ready for deployment to a live system using a production database e.g. Heroku.
- Northcoders Team for assistance and insight.