Skip to content

Shamoel005/Hostel-Hungry

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

158 Commits
 
 
 
 
 
 

Repository files navigation


📖 Hostel Hungry (Vingo) - MERN Food Delivery 🍔

Hostel Hungry is a full-stack food delivery application designed specifically for hostel environments. It features real-time tracking, geolocation-based shop searching, and a dual-interface for both customers and shop owners.


🚀 Features

For Customers

  • Geolocation Search: Automatically finds the best shops in your current city using Geoapify.
  • Real-time Tracking: Track your order status from "Placed" to "Delivered" via Socket.io.
  • Secure Auth: Sign in with Email/Password or Google One-Tap (Firebase).
  • Menu Browsing: Browse items by category (Pizza, Burger, etc.) with smooth horizontal scrolling.
  • Password Recovery: Secure OTP-based password reset powered by Brevo SMTP.

For Shop Owners

  • Merchant Dashboard: Create and manage your shop profile, including address and shop image.
  • Item Management: Add, edit, or delete food items with real-time updates.
  • Order Management: Accept orders and update statuses to keep customers informed.

🛠️ Tech Stack

Frontend

  • React.js (Vite)
  • Redux Toolkit (State Management)
  • Tailwind CSS (Styling)
  • Firebase (Google Authentication)
  • Socket.io-client (Real-time updates)

Backend

  • Node.js & Express
  • MongoDB & Mongoose (Database)
  • JWT & Cookie-Parser (Authentication)
  • Nodemailer & Brevo (Email/OTP Service)
  • Cloudinary (Image Hosting)
  • Geoapify (Geocoding API)

⚙️ Environment Variables

To run this project, you will need to add the following environment variables to your .env file in the backend folder:

PORT=5000
MONGO_URI=your_mongodb_connection_string
JWT_SECRET=your_secret_key
EMAIL=your_brevo_sender_email
PASS=your_brevo_smtp_key
CLOUDINARY_CLOUD_NAME=your_name
CLOUDINARY_API_KEY=your_key
CLOUDINARY_API_SECRET=your_secret

🛠️ Installation & Setup

  1. Clone the repository:
git clone https://github.com/yourusername/hostel-hungry.git
  1. Install Backend Dependencies:
cd backend
npm install
  1. Install Frontend Dependencies:
cd ../frontend
npm install
  1. Run the application:
  • Backend: npm run dev (from /backend)
  • Frontend: npm run dev (from /frontend)

📡 API Endpoints

Method Endpoint Description
POST /api/auth/signup Register a new user
POST /api/auth/send-otp Send OTP via Brevo
POST /api/shop/create-edit Create or update Shop profile
GET /api/item/get-by-shop/:id Fetch menu for a specific shop

About

Hostel Hungry is a high-performance MERN-stack platform built to bridge the gap between local eateries and students. It combines precise geolocation and real-time order tracking to ensure that "hostel cravings" are met with speed and reliability.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages