The Cab Management Project is a cloud-based application that aims to streamline the management of drivers, cabs, and their assignments. It provides a user-friendly interface for creating, updating, and deleting driver and cab details, as well as assigning drivers to cabs and vice versa. The project is divided into three problem statements: Driver Details App, Cabs App, and Cab Management App.
Driver Details:
Create, Read, Update, Delete Drivers: Users can add new drivers, retrieve a list of all drivers, update driver information, and delete drivers from the system.
Driver Information: Each driver is associated with a name, ID number, email, and phone number.
Database Persistence: Driver details are stored and persisted in the database.
Cabs Details :
Create, Read, Update, Delete Cabs: Users can create new cabs, view all existing cabs, update cab details, and delete cabs from the system.
Cab Information: Each cab is identified by a registration number and has additional details such as model and color.
Database Persistence: Cab details are stored and persisted in the database.
Cab Management Details:
Driver Page: Users can select a driver from the list of drivers and assign, update, or delete a cab for the selected driver.
Cab Page: Users can select a cab from the list of cabs and assign, update, or delete the driver assigned to the selected cab.
Database Persistence: All driver-cab assignment details are stored and persisted in the database.
- Spring Framework: A popular Java framework for building web applications.
- Docker: A containerization platform used to package the application and its dependencies into containers for easy deployment and scalability.
- AWS EC2: A cloud computing platform provided by Amazon Web Services used for hosting the application.
- ReactJS: A JavaScript library for building user interfaces.
- Material-UI: A UI library that provides pre-designed components and styles for React applications.
- Java: The programming language used in the backend development with Spring Framework.
- Axios: A JavaScript library used for making API requests from the frontend.
DriverController.java
- POST /driverapi: Create a new driver in the database.
- GET /driverapi: Get a list of all drivers.
- PUT /driverapi: Update an existing driver's details.
- DELETE /driverapi/
{driverIdNumber}: Delete a driver with the given ID. - POST /driverapi/
{driverIdNumber}/cab/{cabRegistrationNumber}: Assign a cab to a driver. - PUT /driverapi/
{driverIdNumber}/cab/{cabRegistrationNumber}: - - - Update the assigned cab for a driver. - GET /driverapi/
{driverIdNumber}/cab: Get the assigned cab for a driver. - DELETE /driverapi/
{driverIdNumber}/cab: Remove the assigned cab for a driver.
CabController.java
- POST /cabapi: Create a new cab in the database.
- GET /cabapi: Get a list of all cabs.
- PUT /cabapi: Update an existing cab's details.
- DELETE /cabapi/
{cabRegistrationNumber}: Delete a cab with the given registration number. - POST /cabapi/
{cabRegistrationNumber}/driver/{driverIdNumber}: Assign a driver to a cab. - PUT /cabapi/
{cabRegistrationNumber}/driver/{driverIdNumber}: Update the assigned driver for a cab. - GET /cabapi/
{cabRegistrationNumber}/driver: Get the assigned driver for a cab. - DELETE /cabapi/
{cabRegistrationNumber}/driver: Remove the assigned driver for a cab.
This repository contains the backend microservice for the Cab Management Project, which provides functionality for managing drivers, cabs, and their associations.
Before proceeding with the installation and deployment, ensure that you have the following:
1)An AWS account with EC2 instance access.
2)Inbound rule allowing HTTP traffic (port 8080) to your EC2 instance.
3)Docker installed on your EC2 instance.
1.Clone the Repository:
Clone this repository to your local machine .
2.Update the application.properties File:
Open the application.properties file located in the Spring Boot project and update the database URL to:
spring.datasource.url=jdbc:mysql://mysqldb:3306/cabmanagement?useSSL=false&allowPublicKeyRetrieval=true
3.Build the Spring Boot Application .jar file:
Use GUI or command to build spring boot application that will give you cabmanagement-0.0.1-SNAPSHOT.jar file in target folder.
4.Transfer the .jar File to EC2 instance :
Use the scp command to transfer the generated .jar file to your EC2 instance. Replace <path-to-your-keypair> with the path to your key pair file and <ec2-instance-public-ip-or-dns> with the public IP or DNS of your EC2 instance.
scp -i <path-to-your-keypair>.pem target/cabmanagement-0.0.1-SNAPSHOT.jar ubuntu@<ec2-instance-public-ip-or-dns>
5.Pull the mysql:8 and openjdk:20 Image in EC2 :
Pull the mysql:8 and openjdk:20Docker image from Docker Hub:
docker pull mysql:8
docker pull openjdk:20
6.Create a Docker Network:
Create a Docker network to enable communication between the Spring Boot app and the MySQL container.
docker network create springbootapi
7.Run the MySQL Container:
Run the MySQL container within the created network.
docker run -d --name mysqldb --network springbootapi -e MYSQL_ROOT_PASSWORD=rootboot mysql:8
9.Access the MySQL Container and Create the Database:
Access the MySQL container and create the required database.
docker exec -it mysqldb mysql -u root -prootboot
Enter the MySQL root password when prompted.
CREATE DATABASE cabmanagement;
10.Create a Dockerfile:
Create a Dockerfile where your cabmanagement-0.0.1-SNAPSHOT.jar
redises and write following code in it:
FROM openjdk:20
COPY target/cabmanagement-0.0.1-SNAPSHOT.jar cabmanagement.jar
ENTRYPOINT["java","-jar","/cabmanagement.jar"]
11.Build the Docker Image:
Once Docker is installed, navigate to the directory where you transferred the .jar file and run the following command to build the Docker image:
docker build -t cabbackend .
12.Run the Docker Container:
After the Docker image is built, run the following command to start the Docker container:
docker run -d -p 8080:8080 --network springbootapi --name cabmanagement cabmanagementbackend
1.Clone the Repository:
Clone this repository to your local machine or directly access it from your EC2 instance.
2.Transfer the Repository:
Transfer the repository to your EC2 instance using the scp command or any other preferred method.
3.SSH into the EC2 Instance:
Connect to your EC2 instance using SSH. Replace <path-to-your-keypair>with the path to your key pair file and <ec2-instance-public-ip-or-dns> with the public IP or DNS of your EC2 instance.
ssh -i <path-to-your-keypair>.pem ubuntu@<ec2-instance-public-ip-or-dns>
4.Install Docker and Docker Compose: Install Docker and Docker Compose on your EC2 instance by following the official installation instructions.
5.Navigate to the Repository: Navigate to the repository directory on your EC2 instance.
cd cab-management-backend
Update the Environment Variables:
Update the environment variables in the docker-compose.yml file as per your requirements.
Run Docker Compose:
Run the following command to start the Docker containers
docker-compose up -d
Open a web browser or any software like postman and enter the following URL to access the backend microservice:
use endpoints cabapi and driverapi refer controller structure in springboot project for successful API communication.
http://<ec2-instance-public-ip-or-dns>:8080/cabapi
http://<ec2-instance-public-ip-or-dns>:8080/driverapi
If you have any questions or suggestions, please feel free to reach out to us. Contact Email: abhinandmanwate123@gmail.com, bhilegaonkarprasanna12@gmail.com, adityabile30602@gmail.com