FastFoodFast

A fast food delivery app for a restaurant

Getting Started

To get a copy of the project for development and testing purpose

• download or clone this repository

  $ git clone https://github.com/ah-med/FastFoodFast.git

- Migrate to project folder
``` bash
  $ cd FastFoodFast

• Install dependencies

  $ npm Install

Prerequisites

These are some of the software you will need to install on your machine

• Node.js - A back-end framework built with Javascript.
• Expressjs - A web framework for NodeJS.
• Git - A free and open source distributed version control system
• Postman - To test API endpoints
• Nodemon - Tracks changes in files during development and restart server
• Any editor of your choice.

Installing

To get the development environment running

• Install all dependencies

$ npm install 

• Start the application

 $ npm run start

• Start the application using nodemon

 $ npm run prod-start

• Don't forget to add environment variables as required in the .env.default file

Running the tests

You can also run the tests

$ npm run test

For coverage

$ npm run coverage

Built With

• Node.js - A back-end framework built with Javascript.
• Expressjs - A web framework for NodeJS.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

WeFor the versions available, see the tags on this repository.

Author

• Ahmed Omosanya

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Andela 21