Skip to content

README.md

Latest commit

 

History

History
144 lines (101 loc) · 4.63 KB

README.md

File metadata and controls

144 lines (101 loc) · 4.63 KB

QuickStay

QuickStay

QuickStay is a full-stack hotel booking web application built using the MERN Stack. It enables users to search hotels, book stays, and manage reservations with ease. Admins can manage listings and bookings through a secure dashboard.

Features

User Functionality

  • Browse and search for hotels
  • Book hotels with check-in and check-out
  • View detailed hotel information (images, amenities)
  • Manage bookings from user dashboard
  • Secure authentication powered by Clerk

Admin Functionality

  • Add new hotel listings
  • Edit hotel details & availability
  • Monitor all bookings in admin dashboard
  • Protected routes using authentication middleware

Tech Stack

Technology Icon Description
MongoDB NoSQL DB for hotels, users & bookings
Express.js Backend framework for APIs
React.js Frontend UI library
Node.js Backend runtime
Clerk Authentication & user management
Cloudinary Image storage & optimization
Mongoose MongoDB schema modeling
Axios API communication
Tailwind CSS Utility-first UI styling

Folder Structure

QuickStay/
├── client/                # React Frontend
│   ├── src/
│   │   ├── components/
│   │   ├── pages/
│   │   ├── App.js
│   │   └── ...
├── server/                # Express Backend
│   ├── controllers/
│   ├── routes/
│   ├── models/
│   ├── middleware/
│   ├── configs/
│   ├── server.js
│   └── ...

Installation & Setup

Backend

cd server
npm install
npm run server

Frontend

cd client
npm install
npm start

Environment Variables

Server .env

PORT=5000
MONGO_URI=your_mongodb_uri
CLOUDINARY_CLOUD_NAME=your_cloud_name
CLOUDINARY_API_KEY=your_api_key
CLOUDINARY_API_SECRET=your_api_secret
CLERK_SECRET_KEY=your_clerk_secret

Client .env

VITE_CLERK_PUBLISHABLE_KEY=your_clerk_key
VITE_API_BASE_URL=http://localhost:5000/api

Future Enhancements

  • Payment gateway (Razorpay / Stripe)
  • Map-based hotel location view
  • Better mobile responsiveness
  • Email notifications

Contribution

git clone https://github.com/manishkumar8312/QuickStay.git

Pull requests are welcome!

License

Licensed under the MIT License.

Acknowledgments

  • Clerk
  • Cloudinary
  • MERN community resources