The Bengal Chefs' Pantry - Server Side

Welcome to the server-side repository of The Bengal Chefs' Pantry, a dedicated website showcasing the finest recipes from the best chefs. This server handles API requests.

Table of Contents

• Features
• Technologies Used
• Prerequisites
• Project Structure
• Installation
• Configuration
• Live Server
• Running the Application
• API Endpoints
• Also Checkout The Bengal Chefs' Pantry - Client
• Contributing
• License

Features

• RESTful API for banner dishes, headlines, chefs, tips and tricks, and health tips.
• Secure environment-based configuration.
• Data retrieval and management for various culinary data.

Technologies Used

• Node.js
• Express.js

Prerequisites

• Node.js and npm installed.

Project Structure

├── .gitignore          # Lists files for Git to ignore
├── README.md           # Project documentation
├── index.js            # Main entry point of the application
├── package-lock.json   # Exact dependency tree
├── package.json        # Project metadata and dependencies
├── vercel.json         # Vercel deployment settings
├── data                # Directory containing JSON files with mock data
│   ├── bannerDishes.json
│   ├── chefs.json
│   ├── healthTips.json
│   ├── headlines.json
│   └── tipsAndTricks.json

Installation

1. Clone the repository:

   git clone https://github.com/Tanzeebul-Tamim/The-Bengal-Chefs-Pantry-Server
   cd The-Bengal-Chefs-Pantry-Server

2. Install dependencies:

   npm install

Configuration

Create a .env file in the root directory and add the following environment variables:

PORT=5000

Live Server

The server is deployed on this following URL

Running the Application

• Start the server:

  npm start

API Endpoints

• GET /: Health check endpoint. Returns a simple message indicating the server is running.
• GET /bannerdishes: Retrieve all banner dishes.
• GET /headlines: Retrieve all headlines.
• GET /chefs: Retrieve all chefs.
• GET /tips: Retrieve all tips and tricks.
• GET /healthtips: Retrieve all health tips.

Also checkout The-Bengal-Chefs-Pantry-Client

Visit the client-side repository of The Bengal Chefs' Pantry website

Contributing

Feel free to contribute by submitting a pull request. Please ensure that your code follows the project's coding standards and includes relevant tests.

License

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