🏨 EZStay

A modern Full Stack Accommodation Booking Platform built using React.js, Node.js, Express.js, and MySQL. EZStay allows users to explore accommodations across multiple cities while providing a secure admin dashboard for managing cities and stays.

📖 About The Project

EZStay is a full-stack accommodation booking platform designed to simulate a real-world hotel and stay booking experience.

Users can browse available cities, explore accommodations, and view stay details through an intuitive and responsive interface. Administrators have access to a secure dashboard where they can manage cities and accommodation listings.

The project demonstrates complete frontend-backend integration, RESTful API development, JWT-based authentication, role-based authorization, MySQL database management, and responsive UI development.

It serves as a practical implementation of modern full-stack web development concepts using the MERN-inspired architecture with a MySQL relational database.

✨ Features

👤 User Features

User Registration
Secure Login using JWT Authentication
Browse Available Cities
Explore Available Stays
View Stay Details
Responsive User Interface

👨‍💼 Admin Features

Secure Admin Login
Add New Cities
Delete Cities
Add New Accommodation Listings
Delete Accommodation Listings
Protected Admin Dashboard
Role-Based Authorization

🔐 Authentication & Security

JWT Authentication
Password Hashing using BCrypt
Protected Routes
Role-Based Access Control
Secure API Communication

🗄 Database Features

MySQL Relational Database
City Management
Accommodation Management
User Management
Foreign Key Relationships
Persistent Data Storage

🎨 User Interface

Responsive Layout
Modern Card Design
Clean Navigation
Mobile Friendly
Bootstrap Components
Elegant Yellow Theme

📸 Application Screenshots

🏠 Home Page

🔐 Authentication

Login	Register

👤 User Interface

🏨 Available Stays

🛏 Stay Details

👨‍💼 Admin Dashboard

➕ Add New Stay

🌐 Live Demo

Frontend: (Deployment currently unavailable due to expired cloud database service. The project runs completely in a local development environment.)

React Frontend
⬇
Node.js + Express Backend
⬇
MySQL Database

⭐ Project Highlights

🌍 Full Stack Web Application
🔐 JWT Authentication
👨‍💼 Role-Based Authorization
🏨 Accommodation Management
🏙 City Management
🗄 MySQL Database Integration
⚡ RESTful APIs
📱 Responsive Design
🎨 Modern User Interface
🚀 Production-Ready Architecture

🛠 Tech Stack

🎨 Frontend

Technology	Purpose
React.js	Frontend Development
React Router DOM	Client-side Routing
Bootstrap	Responsive UI Components
Axios	API Communication

⚙ Backend

Technology	Purpose
Node.js	Runtime Environment
Express.js	REST API Development
JWT	Authentication & Authorization
BCrypt	Password Hashing

🗄 Database

Technology	Purpose
MySQL	Relational Database
mysql2	Database Connectivity

🚀 Development Tools

Tool	Purpose
VS Code	Code Editor
Git	Version Control
GitHub	Repository Hosting
Postman	API Testing

🏗 System Architecture

                    ┌──────────────────────┐
                    │      React Client     │
                    │   (Frontend UI)       │
                    └──────────┬────────────┘
                               │
                         HTTP Requests
                               │
                               ▼
                    ┌──────────────────────┐
                    │ Express.js REST API  │
                    │      Node.js         │
                    └──────────┬────────────┘
                               │
                  JWT Authentication Layer
                               │
                               ▼
                    ┌──────────────────────┐
                    │      MySQL Database   │
                    └──────────────────────┘

📂 Project Structure

EZStay
│
├── assets
│   ├── banner
│   │   └── banner.png
│   │
│   └── screenshots
│       ├── home.png
│       ├── loginWindow.png
│       ├── signupWindow.png
│       ├── userInterface.png
│       ├── adminDashboard.png
│       ├── addStayAdmin.png
│       ├── stays.png
│       └── stayDetails.png
│
├── client
│   ├── public
│   ├── src
│   │   ├── components
│   │   ├── pages
│   │   ├── services
│   │   ├── styles
│   │   └── App.js
│   └── package.json
│
├── server
│   ├── controllers
│   ├── db
│   ├── middleware
│   ├── routes
│   ├── index.js
│   ├── package.json
│   └── .env.example
│
├── database
│   └── ezstay.sql
│
├── README.md
└── .gitignore

🗄 Database Design

The project uses a MySQL relational database consisting of three primary tables.

Table	Purpose
users	Stores user accounts, roles, and authentication credentials
cities	Stores city information displayed on the homepage
stays	Stores accommodation details linked to individual cities

Relationships

Cities (1)
     │
     │
     ├──────────────► Stays (Many)

Users
│
├── User
└── Admin

🔌 REST API Overview

🔐 Authentication

Method	Endpoint	Description
POST	`/api/auth/register`	Register a new user
POST	`/api/auth/login`	Login user

🏙 Cities

Method	Endpoint	Description
GET	`/api/cities`	Fetch all cities
POST	`/api/cities`	Add new city (Admin)
DELETE	`/api/cities/:id`	Delete city (Admin)

🏨 Stays

Method	Endpoint	Description
GET	`/api/stays`	Fetch all stays
GET	`/api/stays/city/:cityId`	Fetch stays by city
GET	`/api/stays/:id`	Fetch stay details
POST	`/api/stays`	Add new stay (Admin)
DELETE	`/api/stays/:id`	Delete stay (Admin)

🔐 Authentication Flow

User Login
     │
     ▼

Server verifies credentials
     │
     ▼

Password verified using BCrypt
     │
     ▼

JWT Token Generated
     │
     ▼

Token sent to Client
     │
     ▼

Protected Routes Accessible

⚡ Key Functionalities

✔ User Authentication

✔ JWT Authorization

✔ Role-Based Access

✔ RESTful APIs

✔ CRUD Operations

✔ Responsive Interface

✔ MySQL Integration

✔ Protected Admin Dashboard

✔ Secure Password Storage

✔ Dynamic City & Stay Management

🚀 Getting Started

Prerequisites

Before running the project, ensure you have the following installed:

Node.js (v18 or above)
npm
MySQL Server
Git
VS Code (Recommended)

⚙ Installation

1️⃣ Clone the Repository

git clone https://github.com/TanmayT134/EZStay.git

2️⃣ Navigate to the Project

cd EZStay

3️⃣ Install Frontend Dependencies

cd client
npm install

4️⃣ Install Backend Dependencies

cd ../server
npm install

🔑 Environment Variables

Create a .env file inside the server directory.

PORT=5000

DB_HOST=localhost
DB_USER=root
DB_PASSWORD=your_password
DB_NAME=EZStay
DB_PORT=3306

JWT_SECRET=your_secret_key

Alternatively, you can use the provided:

server/.env.example

🗄 Database Setup

Open MySQL Workbench.
Create a new database (if it doesn't already exist).

CREATE DATABASE EZStay;

Import the SQL script located in:

database/ezstay.sql

This script will automatically:

Create all required tables
Insert a demo admin account
Insert sample cities
Insert sample accommodation listings

▶ Running the Application

Start Backend

cd server
npm start

Backend runs on:

http://localhost:5000

Start Frontend

cd client
npm start

Frontend runs on:

http://localhost:3000

👨‍💻 Demo Credentials

Admin

Email	Password
tanmay@test.com	Admin@123

Note: These credentials are provided only for demonstration purposes and can be modified after importing the database.

📈 Future Enhancements

Some planned improvements include:

Hotel Search Functionality
Advanced Filters (Price, Rating, Amenities)
Image Upload using Cloudinary
Booking & Reservation System
Payment Gateway Integration
User Profile Management
Booking History
Wishlist / Favorites
Email Notifications
Google Maps Integration
Reviews & Ratings
Responsive Admin Dashboard
Cloud Deployment with CI/CD
Docker Support

🤝 Contributing

Contributions are welcome!

If you'd like to improve EZStay:

Fork the repository.
Create a new feature branch.

git checkout -b feature/your-feature

Commit your changes.

git commit -m "Add new feature"

Push your branch.

git push origin feature/your-feature

Open a Pull Request.

👨‍💻 Author

Tanmay Tawade

If you enjoyed this project, consider giving it a ⭐ on GitHub.

⭐ If you found this project useful, please consider giving it a Star!

It helps support the project and encourages further development.

Made with ❤️ by Tanmay Tawade

Name		Name	Last commit message	Last commit date
assets		assets
client		client
database		database
server		server
.gitignore		.gitignore
README.md		README.md

Latest commit

History

Folders and files

Repository files navigation

🏨 EZStay

📖 About The Project

✨ Features

👤 User Features

👨‍💼 Admin Features

🔐 Authentication & Security

🗄 Database Features

🎨 User Interface

📸 Application Screenshots

🏠 Home Page

🔐 Authentication

👤 User Interface

🏨 Available Stays

🛏 Stay Details

👨‍💼 Admin Dashboard

➕ Add New Stay

🌐 Live Demo

⭐ Project Highlights

🛠 Tech Stack

🎨 Frontend

⚙ Backend

🗄 Database

🚀 Development Tools

🏗 System Architecture

📂 Project Structure

🗄 Database Design

Relationships

🔌 REST API Overview

🔐 Authentication

🏙 Cities

🏨 Stays

🔐 Authentication Flow

⚡ Key Functionalities

🚀 Getting Started

Prerequisites

⚙ Installation

1️⃣ Clone the Repository

2️⃣ Navigate to the Project

3️⃣ Install Frontend Dependencies

4️⃣ Install Backend Dependencies

🔑 Environment Variables

🗄 Database Setup

▶ Running the Application

Start Backend

Start Frontend

👨‍💻 Demo Credentials

Admin

📈 Future Enhancements

🤝 Contributing

👨‍💻 Author

⭐ If you found this project useful, please consider giving it a Star!

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages