https://github.com/imd10/cs342-car-rental
A Java-based Car Rental System with a GUI for bookings, admin management, notifications, and reports, connected to a PostgreSQL database hosted on AWS.
https://github.com/imd10/cs342-car-rental
aws car-rental desktop-application java postgresql swing visual-programming
Last synced: about 2 months ago
JSON representation
A Java-based Car Rental System with a GUI for bookings, admin management, notifications, and reports, connected to a PostgreSQL database hosted on AWS.
- Host: GitHub
- URL: https://github.com/imd10/cs342-car-rental
- Owner: iMD10
- Created: 2024-11-24T09:55:35.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-01-24T17:39:40.000Z (5 months ago)
- Last Synced: 2025-03-30T03:41:14.892Z (3 months ago)
- Topics: aws, car-rental, desktop-application, java, postgresql, swing, visual-programming
- Language: Java
- Homepage:
- Size: 5.03 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CS342 Car Rental System
This is a Java-based desktop application designed to provide a seamless vehicle rental experience. This project features a graphical user interface for customers and admins, built using Java Swing, with PostgreSQL as the database hosted on AWS. The system supports vehicle booking, user management, and administrative controls.
---
## Table of Contents
1. [Features](#features)
2. [Application Overview](#application-overview)
3. [Folder Structure](#folder-structure)
4. [Technologies Used](#technologies-used)
5. [Installation](#installation)
6. [Usage](#usage)
7. [Contributors](#contributors)
---
## Features
### Customer Features
- **Browse Vehicles**: View available vehicles and filter by type or availability date.
- **Book Vehicles**: Easily book vehicles and specify rental dates.
- **View Bookings**: Manage active, completed, or canceled bookings.
- **Notifications**: Receive reminders about booking deadlines.
- **Invoices**: Generate and download PDF invoices for completed bookings.
- **My Account**: Update account details, such as name, phone number, and password.
### Admin Features
- **Manage Vehicles**: Add, edit, or remove vehicles in the fleet.
- **Manage Bookings**: Oversee all bookings, including the ability to cancel them.
- **Generate Reports**: View detailed analytics, such as total revenue, active bookings, and customer statistics.
---
## Application Overview
The customer dashboard provides a simple and intuitive interface for users to browse vehicles, book rentals, and view notifications.
---
The admin dashboard allows administrators to manage vehicles, bookings, and view detailed reports.
---
## Folder Structure
```
CS342-Car-Rental/
├── .idea/ # IntelliJ IDEA configuration files
├── report/ # Documentation files for the project
├── src/
│ ├── main/java/org/example/
│ ├── classes/ # Core business entities (e.g., User, Booking, Vehicle)
│ ├── common/ # Shared utilities (e.g., Validation, DatabaseHandler)
│ ├── controllers/ # Controllers for handling database operations
│ ├── res/ # Resources (images/icons for GUI) and schema for database in SQL
│ ├── view/ # Main GUI components (Admin and Customer GUIs)
│ ├── views/ # Additional GUI components for customer functionality
│ └── Main.java # Main entry point of the application
├── .gitignore # Git ignore rules
├── pom.xml # Maven project configuration
```
### Explanation of Key Folders
- **`classes/`**: Contains core entities, such as `User`, `Vehicle`, `Booking`, and `Invoice`.
- **`common/`**: Provides shared utilities, including error handling and input validation.
- **`controllers/`**: Implements the logic for interacting with the PostgreSQL database (e.g., fetching vehicles, bookings, and invoices).
- **`view/`**: Includes GUI components like admin and customer dashboards.
- **`views/`**: Contains additional customer-focused GUIs (e.g., booking notifications).
---
## Technologies Used
- **Java (Swing)**: For creating the graphical user interface.
- **PostgreSQL**: AWS-hosted relational database for storing application data.
- **Maven**: For managing project dependencies and building the application.
- **iText**: For generating PDF invoices.
- **FlatLaf**: Modern UI design for enhancing the application's appearance.
---
## Installation
1. **Clone the repository**:
```bash
git clone https://github.com/iMD10/CS342-Car-Rental.git
cd CS342-Car-Rental
```
2. **Database setup**:
- Set up a PostgreSQL database and import the required tables.
- Update the database connection details in the `DatabaseHandler` class.
3. **Build the project**:
```bash
mvn clean install
```
4. **Run the application**:
Open and run `Main.java` from your IDE.
---
## Usage
### For Customers:
- **Sign Up**: Register with your details to create a new account.
- **Book a Vehicle**: Browse the available vehicles and book one for your desired dates.
- **Invoices**: View and generate invoices for completed bookings.
- **My Account**: Update your personal information, such as phone number and password.
### For Admins:
- **Manage Vehicles**: Add, update, or delete vehicles in the fleet.
- **View Reports**: Access analytics, such as revenue and active bookings.
- **Manage Bookings**: Oversee all bookings and handle cancellations.
---
## Contributors
This project was collaboratively developed by:
- **Muhannad Majed**
GitHub: [@iMD10](https://github.com/iMD10)
- **Mohammed Saleh**
GitHub: [@rayq-q](https://github.com/rayq-q)
- **Mohammed Mansour**
GitHub: [@MrM3ROF](https://github.com/MrM3ROF)
- **Eyad Fahad**
GitHub: [@commando-xxt](https://github.com/commando-xxt)
- **Amer Mohammed**
GitHub: [@3wex](https://github.com/3wex)
- **Faisal Qasim**
GitHub: [@csx30](https://github.com/csx30)
---
We hope you find our project useful! Feel free to contribute or report issues.