Book-A-Meal

Book-A-Meal is an app designed to let you order meals from your favourite resturant at your convience. To use you can check a day's menu and place orders.

Table of Content

• Features
• Technologies & Tools
• API
• Installation
• Testing

Features

1. User can view menu for the day without an account
2. User is able to signin and signup as a caterer or customer
3. Customer is able to see menu for the day
4. Customer is able to place orders
5. Customer is able to cancel order after 15 mins of placing the order
6. Customer is able to view their order history
7. Caterer is able to set menu for a specific day or 2 days ahead
8. Caterer can edit or modify menu on or before the "post on" date
9. Caterer is able to create meal
10. Caterer (Admin) is able to edit or remove meal
11. Caterer (Admin) is able to see their order history
12. Caterer (Admin) is able to see their total sale for a day

App Link

View app at Book-A-Meal

API Documentation

View on SWAGGER

Technologies & Tools

• HTML - For UI templating
• SCSS - For styling UI templates
• Font Awesome for icons
• Node js - Run time environment
• NPM - Dependency Manager
• Express - Web application framework
• React js - For interactive, responsive and dynamic UI
• Webpack - Module bundler
• Eslint - code linter
• Babel - compiler
• Pivotal Tracker for tracking project tasks
• Mocha - testing framework
• Chai - assertion library for node
• Istabul nyc - test coverage generator

Installation

• Install Node js and PostgreSQL
• Git clone this repo
• Install sequelize-cli globally on your local machine
• Navigate to the directory
• Run npm install to install dependencies
• Run sequelize db:migrate to migrate database to postgres

Development

• Run npm run start:dev in development
• • Navigate to localhost:9000 in your browser to view app

Production

• Run npm run build
• Run start
• Navigate to localhost:9000 in your browser to view app

Testing

• Run npm run test
  • For End to End test
  • • Install Java JDK on your Local machine
  • • npm run e2e:setup
  • • npm run e2e:server
  • • npm run client:dev
  • • npm run e2e:start

Release

• Version 1.0.0
  • Still in developement

Contributing

This app is open to suggestions and contribution. To contribute follow the steps below:

• Fork this project and clone locally
• Work on the project and create a branch for each separate work
• Ensure to test your contribution
• Ensure to write good commit messages
• When done push to your origin repo
• Create a Pull request

Authors

• Ogooluwa Akinola

Acknowledgments

• Andela

License

MIT License