BOOK A MEAL APP

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. This tracking helps keep work in order. Find it on https://bevkololi.github.io or clone the files from https://github.com/bevkololi/Book-A-Meal.git. You can then open index.html file on your browser. Documentation is also here https://bookameal2.docs.apiary.io/#

TECHNOLOGIES USED

The application is built using the following technologies:

1. Python 3.6
2. Flask Microframework

Dependancies are installed in the requirements.txt tile, as long as one has set up one's own virtual environments. Process of using it includes customer sign up and loging in to access meals and make orders.

UI

The UI page contains:

1. User sign up and sign in pages
2. A ppage where the caterer can perform CRUD operations i.e Create, Read, Update and modify meals
3. A page where the caterer can add the meals of the day
4. A page where users can see the menu
5. A page where users can order the meal they want.

The following is a preview of the application:

Unit testing

The following tests have beeen setuo:

1. test_meals.py: To test on the addition, updating or removal of meals
2. test_orders.py: To test how to get the orders given by the customers
3. test_auth.py: To test the sign in and login of applications Pytest is much prefered in conducting these tests.

API ENDPOINTS

The following are the API endpoints used in the application:

1. /api/auth/signup: To register a user
2. /api/auth/login: To login an authenticated user
3. /api/v1/meals: To get meals available
4. /api/v1/meals/int:id: To get meal using its meal id, and update or delete it
5. /api/v1/orders: To get all the orders 6: /api/v1/orders/: To get orders by a particular customer

The endpoints have been tested on postman. Here are the expected outcomes:

Feedback is much appreciated.

Enjoy 