Book-A-Meal is an application that allows customers to make food orders and helps the food vendor know what the customers want to eat.
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.
- Git
- Python 3.6.4
- Virtualenv
- Clone the repository
$ git clone https://github.com/lennykioko/Book-A-Meal.git
$ cd into the created folder
- Initialize and activate a virtualenv
$ virtualenv --no-site-packages env
$ source env/bin/activate
- Install the dependencies
$ pip install -r requirements.txt
- Initialize environment variables
$ export SECRET_KEY=<SECRET KEY>
$ export TESTING_DATABASE_URI=<URI>
$ export DEVELOPMENT_DATABASE_URI=<URI>
- Run migrations
$ python manage.py db upgrade
- Run the development server
$ python app.py
- Navigate to http://localhost:5000
At the / endpoint you should see Welcome to Book-A-Meal API displayed in your browser.
Here is a list of all endpoints in the Book-A-Meal API
| Endpoint | Functionality |
|---|---|
| POST /api/v1/auth/signup | Register a user |
| POST /api/v1/auth/login | Log in user |
| POST /api/v1/auth/reset | Reset password |
| POST /api/v1/users | Create a user |
| GET /api/v1/users | Get all users |
| GET /api/v1/users/id | Get a single user |
| PUT /api/v1/users/id | Update a single user |
| DELETE /api/v1/users/id | Delete a single user |
| POST /api/v1/meals | Create new meal item |
| GET /api/v1/meals | Get all meal items |
| GET /api/v1/meals/id | Get a single meal item |
| PUT /api/v1/meals/id | Update a single meal item |
| DELETE /api/v1/meals/id | Delete a single meal item |
| POST /api/v1/menu | Create new menu option |
| GET /api/v1/menu | Get all menu options |
| GET /api/v1/menu/id | Get a single menu option |
| PUT /api/v1/menu/id | Update a single menu option |
| DELETE /api/v1/menu/id | Delete a single menu option |
| POST /api/v1/orders | Create new order item |
| GET /api/v1/orders | Get all order items |
| GET /api/v1/orders/id | Get a single order item |
| PUT /api/v1/orders/id | Update a single order item |
| DELETE /api/v1/orders/id | Delete a single order item |
To run the automated tests simply run
nosetests tests
Coding styles tests are tests that ensure conformity to coding style guides. In our case, they test conformity to PEP 8 style guides
pylint app.py
Ensure you use ProductionConfig settings which have DEBUG set to False
- HTML5
- CSS3
- Python 3.6.4
- Flask - The web framework used
https://book-a-meal-api.herokuapp.com/apidocs
Most recent version is version 3
Lenny Kioko.
This project is licensed under the MIT License - see the LICENSE file for details
- Hat tip to anyone who's code was used
- Inspiration and encouragement
- etc