Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/surajmendhe5573/restaurent-api
https://github.com/surajmendhe5573/restaurent-api
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/surajmendhe5573/restaurent-api
- Owner: surajmendhe5573
- Created: 2024-02-03T14:49:11.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-02-10T09:45:35.000Z (9 months ago)
- Last Synced: 2024-02-10T10:29:28.518Z (9 months ago)
- Language: JavaScript
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node Restaurent Application
The **Node Restaurent** application is a Node.js-based system developed using the Express.js framework, with MongoDB as the chosen database. This application manages information related to persons (staff) and menu items. It exposes specific endpoints to handle CRUD (Create, Read, Update, Delete) operations for both persons and menu items.
## Endpoints
### Persons
- **Add a Person:**
- Endpoint: `POST /person`
- Description: Adds a person to the system with details such as name, role, etc.
- **Get All Persons:**
- Endpoint: `GET /person`
- Description: Retrieves a list of all persons in the system.
- **Get Persons by Work Type:**
- Endpoint: `GET /person/:workType`
- Description: Retrieves a list of persons based on their work type (e.g., chef, waiter, manager).
- **Update a Person:**
- Endpoint: `PUT /person/:id`
- Description: Updates the details of a specific person identified by their ID.
- **Delete a Person:**
- Endpoint: `DELETE /person/:id`
- Description: Deletes a person from the system based on their ID.
### Menu Items
- **Add a Menu Item:**
- Endpoint: `POST /menu`
- Description: Adds a menu item to the system with details such as name, price, taste, etc.
- **Get All Menu Items:**
- Endpoint: `GET /menu`
- Description: Retrieves a list of all menu items in the system.
- **Get Menu Items by Taste:**
- Endpoint: `GET /menu/:taste`
- Description: Retrieves a list of menu items based on their taste (e.g., sweet, spicy, sour).
- **Update a Menu Item:**
- Endpoint: `PUT /menu/:id`
- Description: Updates the details of a specific menu item identified by its ID.
- **Delete a Menu Item:**
- Endpoint: `DELETE /menu/:id`
- Description: Deletes a menu item from the system based on its ID.
## Data Models
### Person
The `Person` data model represents information about staff members in the hotel.
- **Fields:**
- `name`: String (Person's name)
- `age`: Number (Person's age)
- `work`: Enum (Role in the hotel, such as chef, waiter, manager)
- `mobile`: String (Person's mobile number)
- `email`: String (Person's email address, unique)
- `address`: String (Person's address)
- `salary`: Number (Person's salary)
- **Example:**
```json
{
"name": "John Doe",
"age": 30,
"work": "waiter",
"mobile": "123567890",
"email": "[email protected]",
"address": "123 Main Street",
"salary": 30000
}
### Menu Item
The `MenuItem` data model represents information about menu items available in the hotel.
- **Fields:**
- `name`: String (Item's name)
- `price`: Number (Item's price)
- `taste`: Enum (Item's taste, such as sweet, spicy, sour)
- `num_sales`: Number (Number of sales for the item, default is `0`)
- **Example:**
```json
{
"name": "Spicy Chicken Curry",
"price": 1200,
"taste": "spicy",
"num_sales": 50
}
## Usage
1. **Install Dependencies:**
```bash
npm install