Skip to content

A Node.js web server that retrieves data from the Swiggy API and provides it to the MealMingle application.

Notifications You must be signed in to change notification settings

anchalarora/meal-mingle-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🍽️ Meal Mingle Server

Overview

The Meal Mingle Server is a Node.js server built to call the Swiggy API and handle Cross-Origin Resource Sharing (CORS) issues 🌐. It acts as the backend for the Meal Mingle Frontend, Live at : Meal Mingle App ensuring smooth API communication between the client and external services like Swiggy πŸš€.

This server is part of the Meal Mingle project Meal Mingle Frontend, which allows users to browse meals, place orders, and interact with a modern, user-friendly meal ordering system. πŸ₯‘πŸ₯—

Features

  • Proxy Server: πŸ› οΈ Makes API calls to Swiggy to fetch restaurant and meal data.
  • CORS Handling: 🚧 Resolves CORS issues, allowing secure communication between the frontend and Swiggy API.
  • Seamless Integration: ⚑ Works perfectly with the Meal Mingle frontend app to provide a smooth user experience.
  • Efficient Performance: πŸ’¨ Built with Node.js for fast API handling and performance optimization.

Endpoints

  1. /api/restaurants: πŸ“ Returns a list of restaurants by interacting with the Swiggy API.

  2. /api/menu: πŸ“œ Returns a list of menu items from a selected restaurant by calling Swiggy’s menu API.

  3. /: πŸŽ‰ A simple root route to test server availability and link to the Meal Mingle live web app.

Getting Started

Prerequisites

Make sure you have the following installed before starting:

  • Node.js (v12 or higher) 🟒
  • npm (Node Package Manager) πŸ“¦

Installation

  1. Clone the repository:

    git clone https://github.com/anchalarora/meal-mingle-server.git
  2. Navigate to the project directory:

    cd meal-mingle-server
  3. Install dependencies:

    npm install
  4. Usage Start the server:

    npm start

By default, the server will run on http://localhost:3000 πŸš€.

  1. Server Endpoints:

/api/swiggy: Proxy endpoint to call Swiggy API and return data πŸ“‘. This server is designed to work with the Meal Mingle frontend app. Make sure the frontend points to this server's API πŸŒ‰.

  1. Environment Variables:

Create a .env file in the root of the project to store your environment variables:

PORT=3000

πŸ›‘οΈ CORS Handling

The server handles CORS issues, allowing API calls from the frontend to Swiggy without any restrictions πŸš«πŸ”’.

🌐 Integration with Meal Mingle Frontend

The Meal Mingle server is designed to work alongside the Meal Mingle Frontend App. You can find the frontend app and try it out live here:

Frontend GitHub Repository: Meal Mingle Frontend Live App: Meal Mingle App

πŸ› οΈContributing We welcome contributions! If you'd like to improve this project, feel free to fork the repository and submit a pull request 🀝. Any feedback or suggestions are highly appreciated!

πŸ†License This project is licensed under the MIT License. See the LICENSE file for details.

About

A Node.js web server that retrieves data from the Swiggy API and provides it to the MealMingle application.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published