Restaurant Management System

Overview

The bisbis10 restaurant management system is a backend service designed to handle various operations related to restaurants, their dishes, and customer ratings. The system aims to provide a comprehensive platform for managing restaurant data, including details about the restaurants, their cuisines, dishes, and customer ratings.

Functionality

The system provides the following APIs:

Restaurants API: Manages restaurant data.
Ratings API: Manages customer ratings for restaurants.
Dishes API: Manages the dishes offered by each restaurant.

Technical Aspects

The system is built using Express, leveraging its robust framework for creating RESTful APIs. In my solution, data persistence is managed using PRISMA ORM. PRISMA ORM was chosen for its robust query capabilities, easy integration with SQL databases, and comprehensive migration tooling, which is essential for developing robust applications with evolving data models.

Homework Task

Candidates are expected to design and implement the above APIs, adhering to RESTful principles.

APIs

Restaurants APIs

API Description	Endpoint	Request Body	Response Status
Get all restaurants	GET /restaurants		200 OK
Get restaurants by cuisine	GET /restaurants?cuisine=		200 OK
Get restaurant	GET /restaurants/{id}		200 OK
Add a restaurant	POST /restaurants	{"name": "Taizu","isKosher": false,"cuisines": ["Asian","Mexican","Indian"]}	201 CREATED
Update a restaurant	PUT /restaurants/{id}	{"cuisines": ["Asian"]}	200 OK
Delete a restaurant	DELETE /restaurants/{id}		204 No Content

Ratings APIs

API Description	Endpoint	Request Body	Response Status
Add a restaurant rating	POST /ratings	{"restaurantId": 2, "rating":3.3}	200 OK

Order APIs

API Description	Endpoint	Request Body	Response Status
Order	POST /order	{"restaurantId": 2, orderItems:[{"dishId":12,amount:1},{"dishId":14,amount:1} ]	200 OK

Dishes APIs

API Description	Endpoint	Request Body	Response Status
Add a dish	POST /restaurants/{id}/dishes	{"name":"Shakshuka","description":"Great one","price": 34}	201 CREATED
Update a dish	PUT /restaurants/{id}/dishes/{dishId}	{"description":"Great one","price": 34}	200 OK
Delete a dish	DELETE /restaurants/{id}/dishes/{dishId}		204 No Content
Get dishes by a restaurant	GET /restaurants/{id}/dishes		200 OK

Jump Start

For your convenience, docker-compose.yml includes Postgresql DB, the app is already pointing to this connection. In addition, you have the schema and data SQL files that can setup your DB schema and init data.

Prerequisite

Node - https://nodejs.org/en
Docker - https://www.docker.com/products/docker-desktop/

Running Instructions

Before running the application, please make sure that the Docker Desktop is running on your machine.

To run the application, please execute the following commands:

Deployment: Run npm run deploy to start the application.
Testing: Run npm test to execute the tests.
Database UI: Run npm run prisma_ui to access the database UI.

For your convenience, a Postman collection has been created to facilitate specific tests more easily.

Instructions

Fork this repo to your GitHub account.
Clone it to your local machine.
Complete the task.
On completion, send your repo link to the [email protected] email, (a snapshot will be taken from your repo once you submit the homework). Please do not update your repo after you submit the homework.

yuvaltzoor / bisbis10-ts-task Goto Github PK

bisbis10-ts-task's Introduction