NSC Wedding Car Rentals 🚗

Make your wedding day much more easier

A full-stack web application for wedding car rental services, providing a seamless platform for customers to book vehicles, manage reservations, and track vehicle maintenance.

---

📋 Table of Contents

• Features
• Technology Stack
• Project Structure
• Getting Started
• Installation
• Environment Variables
• Running the Application
• User Roles

---

✨ Features

Customer Features

• 🔐 User Authentication - Secure login and registration with JWT
• 🚙 Vehicle Browsing - Browse available wedding cars with detailed information
• 📅 Reservation System - Book vehicles for specific dates
• 📝 Customer Reviews - Submit and view customer reviews
• 👤 Profile Management - Update profile details, change password, and manage account
• 🔔 Notifications - Receive updates about reservations and bookings
• 📞 Contact Us - Direct communication channel with the service

Admin Features

• 📊 Admin Dashboard - Comprehensive overview of all operations
• ✅ Vehicle Approvals - Review and approve vehicle listings
• 🔍 User Verification - Verify user accounts and manage permissions
• 📈 Reservation Management - Monitor and manage all reservations
• 🛠️ Spare Parts Inventory - Track and manage spare parts stock

Driver Features

• 🚗 Driver Dashboard - View assigned bookings and schedules
• 📋 Availability Management - Set and update availability status
• 📍 Trip Management - Track and manage assigned trips

Vehicle Owner Features

• ➕ Add Vehicles - List new vehicles for rental
• ✏️ Edit Vehicle Details - Update vehicle information and pricing
• 📊 My Vehicles - Manage personal vehicle listings
• 💰 Earnings Tracking - Monitor rental income

Technician Features

• 🔧 Technician Dashboard - View maintenance requests
• 📝 Damage Requests - Manage vehicle damage reports
• ✅ Accept/Complete Requests - Handle maintenance tasks
• 📅 Schedule Management - Organize work schedule

---

🛠️ Technology Stack

Frontend

• Framework: React 18.2.0
• Build Tool: Vite 5.1.0
• Styling: TailwindCSS 3.4.1
• Routing: React Router DOM 6.22.1
• HTTP Client: Axios 1.6.7
• UI Components:
  • React Icons
  • React Slick (carousel)
  • React Calendar
  • React Hot Toast (notifications)
• PDF Generation: jsPDF
• Printing: React to Print

Backend

• Runtime: Node.js 20.x
• Framework: Express 4.18.2
• Database: MongoDB with Mongoose 8.9.6
• Authentication: JWT (JSON Web Tokens)
• Password Hashing: Bcrypt 5.1.1
• File Upload: Multer 1.4.5
• Environment Variables: dotenv 16.4.7
• Security: CORS enabled

---

📁 Project Structure

NSC-Rentals/
├── Frontend/                 # React frontend application
│   ├── src/
│   │   ├── components/      # Reusable UI components
│   │   ├── pages/           # Application pages
│   │   │   ├── admin/       # Admin-specific pages
│   │   │   ├── driver/      # Driver dashboard
│   │   │   ├── home/        # Home and contact pages
│   │   │   ├── login/       # Authentication pages
│   │   │   ├── reservation/ # Booking pages
│   │   │   ├── technician/  # Technician pages
│   │   │   ├── user/        # User profile pages
│   │   │   └── vehicles/    # Vehicle management pages
│   │   ├── context/         # React Context for state management
│   │   ├── assets/          # Static assets (images, icons)
│   │   └── styles/          # Global styles
│   ├── public/              # Public assets
│   └── package.json
│
├── Backend/                 # Node.js backend application
│   ├── controllers/         # Route controllers
│   ├── models/              # Mongoose schemas
│   │   ├── user.js
│   │   ├── Vehicle.js
│   │   ├── reservation.js
│   │   ├── DriverModel.js
│   │   ├── technician.js
│   │   ├── damageRequest.js
│   │   ├── sparePartsInventory.js
│   │   └── ...
│   ├── routes/              # API routes
│   ├── middlewares/         # Custom middleware
│   ├── uploads/             # File upload directory
│   ├── server.js            # Server entry point
│   └── package.json
│
└── README.md                # This file

---

🚀 Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v20.x or higher) - Download
• npm (comes with Node.js) or yarn
• MongoDB (v6.x or higher) - Download
• Git - Download

System Requirements

• Operating System: Windows, macOS, or Linux
• RAM: Minimum 4GB (8GB recommended)
• Disk Space: At least 500MB free space

---

📥 Installation

1. Clone the repository

   git clone https://github.com/NscRentals/NSC-Rentals.git
   cd NSC-Rentals

2. Install Backend Dependencies

   cd Backend
   npm install

3. Install Frontend Dependencies

   cd ../Frontend
   npm install

4. Set up MongoDB

   • Ensure MongoDB is running on your system
   • Default connection: mongodb://127.0.0.1:27017/NSC-Rentals
   • Or use MongoDB Atlas for cloud database

---

⚙️ Environment Variables

Backend Configuration

Create a .env file in the Backend directory:

# Server Configuration
PORT=4000
NODE_ENV=development

# Database
MONGO_URL=mongodb://127.0.0.1:27017/NSC-Rentals
# Or use MongoDB Atlas:
# MONGO_URL=mongodb+srv://<username>:<password>@cluster.mongodb.net/NSC-Rentals

# JWT Secret
JWT_SECRET=your-super-secret-jwt-key-here

# File Upload Limits (optional)
MAX_FILE_SIZE=5242880

Frontend Configuration

Create a .env file in the Frontend directory:

# Backend API URL
VITE_BACKEND_URL=http://localhost:4000/api

# Other configurations
VITE_APP_NAME=NSC Wedding Car Rentals

⚠️ Security Note: Never commit .env files to version control. They are already included in .gitignore.

---

▶️ Running the Application

Development Mode

Option 1: Run Backend and Frontend Separately

1. Start the Backend Server

   cd Backend
   npm run dev

   Server will start on http://localhost:4000

2. Start the Frontend (in a new terminal)

   cd Frontend
   npm run dev

   Application will open on http://localhost:5173

Option 2: Run from Root Directory

# Start frontend (from root)
npm run dev

Production Mode

1. Build the Frontend

   cd Frontend
   npm run build

2. Preview Production Build

   npm run preview

3. Start Backend in Production

   cd Backend
   npm start

---

👥 User Roles

The application supports multiple user roles with different permissions:

Role	Capabilities
Customer	Browse vehicles, make reservations, submit reviews, manage profile
Vehicle Owner	Add/edit/delete vehicles, view bookings, track earnings
Driver	View assigned trips, update availability, manage schedules
Technician	View damage requests, accept/complete maintenance tasks
Admin	Full system access, approve vehicles/users, manage all operations

---

📄 License

This project is licensed under the ISC License.

---

📞 Support

For issues, questions, or suggestions:

• GitHub Issues: Create an issue
• Email: Contact through the application's Contact Us page

---

Made with ❤️ for making wedding days special

NSC Wedding Car Rentals - Make your wedding day much more easier