ReadMe.md

Restauranté Api

)

Table of Contents

• Project Overview
• Features
• Built with
• APP Link
• API End Points
• Installation
• Test
• Contributing
• License

Project Overview

NodeJs Project is the backend of build of a restaurant app which allows users to check available menu and book a reservation successfully. It was built from scratch using mysql , sequelize , JavaScript, typescript and Node.js

Features

• Users can register/login using website custom forms, or through facebook,
• Users can get all menus
• Users can see menu details by selecting a specific menu
• Users can create reservations
• Users can view the details of a reservation
• Users can view all reservations

Built with

• sql
• mysql
• sequelize
• JavaScript
• Typescript
• Node.js
• Express framework

APP Link

Link to app on heroku.

API End Points

HTTPS	ENDPOINT	DESCRIPTION
POST	/auth/signup	User Registration
POST	/auth/login	User Login
POST	/reservations	Create Reservation
GET	/reservations/	Fetch all Reservations
GET	/reservations/:id	Fetch a Reservation
GET	/products/inDepartment/:department	Fetch products based on Department
GET	/menus	Fetch all Menus
GET	/menus/:id	Fetch a Menu

Installation

• $ git clone https://github.com/oyedejipeace/restaurante-api.git
• $ cd restaurante-api
• $ yarn install , to install dependencies
• Create .env file using the .env.sample file as a guide
• $ yarn start:dev, to start the server Once the server starts-up, you can query the api at http://localhost:8080/ using the end points stated above.

Test

• $ yarn test

Contributing

Feel free to 🍴 fork this repository

👯 Clone this repository to your local machine using https://github.com/oyedejipeace/restaurante-api.git

Make Contributions

🔃 Create a new pull request using https://github.com/oyedejipeace/restaurante-api/compare

License

• MIT license
• Copyright 2018 © Restauranté-api