Restaurant Admin 🍽️

A robust RESTful backend service for managing restaurant menus and orders. This API provides functionality for CRUD operations, searching, filtering, availability control, and status-tracked order handling.

The API is fully documented using OpenAPI (Swagger), providing an interactive way to explore and test the endpoints.

Live Demo: https://api-restaurant-admin.onrender.com
Live API Documentation: https://api-restaurant-admin.onrender.com/api-docs

Features⚡

• Menu Management: Full CRUD (Create, Read, Update, Delete) functionality for menu items.
• Order Handling: Create new orders, retrieve order lists, view specific order details, and update order statuses.
• Advanced Search & Filtering:
  • Filter menu items by category, availability, and price.
  • Perform text-based searches on menu item name and ingredients.
• Pagination: Efficiently query large sets of order data using page and limit parameters.
• Availability Control: Easily toggle the availability of any menu item.
• API Documentation: Interactive API documentation powered by Swagger (OpenAPI) is available at the /api-docs endpoint.

Tech Stack 🚀

Technology	Description
Node.js	JavaScript runtime environment
Express.js	Web framework for building the REST API
MongoDB	NoSQL database to store application data
Mongoose	ODM library for MongoDB and Node.js
dotenv	For managing environment variables
Postman	API endpoints testing
Swagger UI	For generating interactive API documentation

Getting Started ⚙️

To get a local copy up and running, follow these simple steps.

Prerequisites

• Node.js (v20.19.0 or higher)
• npm (Node Package Manager)
• MongoDB instance (local or cloud-based service something like MongoDB Atlas)

Installation & Setup 📦

1. Clone the repository:

   git clone https://github.com/03-bunny-06/restaurant-admin.git

2. Navigate to the server directory:

   cd restaurant-admin/server

3. Install dependencies:

   npm install

4. Create an environment file: Create a .env file in the server directory and add your environment variables.

   # .env
   DATABASE_URL="your_mongodb_connection_string"
   PORT=8080

5. Start the server:

   npm start

The server will start on the port specified in your .env file (or 8080 by default). You can access the API documentation at http://localhost:8080/api-docs.

Data Models 🗂️

MenuItem Schema

{
    name: { type: String, required: true, index: true },
    description: String,
    category: {
        type: String,
        enum: ['Appetizer', 'Main Course', 'Dessert', 'Beverage'],
        required: true
    },
    price: { type: Number, required: true },
    ingredients: [String],
    isAvailable: { type: Boolean, default: true },
    preparationTime: { type: Number, required: true },
    imageLink : { type: String, default: 'https://github.com/Kowshik-8055/restaurant-images/blob/main/default.png?raw=true' }
}

Order Schema

{
    orderNumber: { type: String, unique: true, default: () => `ORD-xxxxxx` },
    items: [
        {
            menuItem: { type: mongoose.Schema.Types.ObjectId, ref: 'Menu' },
            quantity: { type: Number, required: true },
            price: { type: Number, required: true }
        }
    ],
    totalAmount: { type: Number, required: true },
    status: {
        type: String,
        enum: ['Pending', 'Preparing', 'Ready', 'Delivered', 'Cancelled']
    },
    customerName: { type: String, required: true },
    tableNumber: { type: Number, required: true }
}

API Endpoints 🔗

The API is structured into two main routes that handles: Menu and Order. Menu endpoint is for managing restaurant menu items. Order endpoint is for managing customer orders.

Menu Routes (/menu)

Method	Endpoint	Description
GET	/menu	Get menu items with optional filtering.
GET	/menu/search?	Search for menu items by text query.
POST	/menu	Create a new menu item.
GET	/menu/:id	Get a single menu item by its ID.
PUT	/menu/:id	Update a menu item by its ID.
DELETE	/menu/:id	Delete a menu item by its ID.
PATCH	/menu/:id/availability	Toggle the availability status of a menu item.

Order Routes (/orders)

Method	Endpoint	Description
GET	/orders	Get a list of orders with filtering and pagination.
POST	/orders	Create a new order.
GET	/orders/:id	Get details of a single order by its ID.
PATCH	/orders/:id/status	Update the status of an order.

API Testing with Postman 🧪

• The repository includes a collection.json file exported from Postman.
• It contains structured test folders covering authentication, CRUD operations, protected routes, and error cases.
• Developers can import this collection directly into Postman to run predefined requests against the API.

Import Instructions

1. Open Postman
2. Click Import
3. Load the collection.json file
4. Start testing the endpoints