Nikhiltp2000 / Nikhil

Spring Project

Multi Module Spring boot project

About

This project is a multi-module Spring Boot application that allows users to perform GET and POST operations and interact with a MySQL database. The application uses JPA and Hibernate for data persistence and includes modules for controllers, models, repositories, and services. It also incorporates logging using the Log4j2 framework.

Table of Contents

• Modules
• Prerequisites
• Configuration
• Build and Run
• Usage
• Deployment
• cURL
• Shell Script
• shell Script for Docker Container Deployment
• Logging

Modules

The project is organised into the following modules:

• controller: Contains the REST API controllers responsible for handling incoming requests and mapping them to appropriate methods.
• model: Defines the data models or entities used by the application.
• repository: Provides interfaces for data access and communication with the MySQL database using JPA and Hibernate.
• service: Implements the business logic and handles the interactions between controllers and repositories.

Prerequisites

Before running the application, ensure that you have the following prerequisites installed:

• Java Development Kit (JDK) 17
• Maven
• MySQL database server
• IDE : intellij community edition

Configuration

To configure the application:

1. Open the application.properties file located in the src/main/resources directory.

2. Update the database connection details such as spring.datasource.url, spring.datasource.username, and spring.datasource.password according to your MySQL configuration.

3. Update the database connection details and credentials

   • spring.datasource.url: jdbc:mysql://spring-boot-app.cxug5lvbywcj.ap-south-1.rds.amazonaws.com/db-name
   • spring.datasource.username : nikhil
   • spring.datasource.password : Nikhil123.
   • aws.ec2.instance.name : spring-boot-application
   • aws.ec2.instance.dns : ec2-3-110-118-87.ap-south-1.compute.amazonaws.com

4. This project uses AWS RDS to access use the following credentials

   • aws.rds.db.name : spring-boot-app
   • aws.rds.db.endpoint : spring-boot-app.cxug5lvbywcj.ap-south-1.rds.amazonaws.com
   • aws.rds.db.port : 3306
   • aws.rds.db.username : nikhil
   • aws.rds.db.password : Nikhil123.

Build and Run

To build and run the application:

1. open command prompt.
2. Navigate to the root directory of the project.
3. Run the mvn clean install command to build the application.
4. Once the build is successful, start the application using : mvn spring-boot:run command.

Build and Run using profile

• mvn spring-boot:run -pdev : Builds and runs the Spring Boot application for development.
• mvn spring-boot:run -pprod : Builds and runs the Spring Boot application for production.

Usage

• To perform the GET request and retrieve data, use : http://localhost:8080/getdata
• To perform the POST request and add data to the database, use : http://localhost:8080/createuser with the payload in json format.
• User can use tools like postman or cURL to hit the api with the required payload.

Deployment

This project has been deployed on AWS. To access the deployed application, use the following endpoint:

• GET : ec2-3-110-118-87.ap-south-1.compute.amazonaws.com:8080/getdata
• POST : ec2-3-110-118-87.ap-south-1.compute.amazonaws.com:8080/createuser

cURL

• GET : curl http://ec2-3-110-118-87.ap-south-1.compute.amazonaws.com:8080/getdata
• POST : curl -X POST -H "Content-Type: application/json" -d '{"name":"Anika","email":"[e-mail]"}' http://ec2-3-110-118-87.ap-south-1.compute.amazonaws.com:8080/createuser

Shell Script

The project can be runned using the shell script with the profiles (dev and prod) ./run_app.sh dev : Builds and runs the Spring Boot application for development. ./run_app.sh prod : Builds and runs the Spring Boot application for production.

shell Script to create and docker container

• ./run_docker.sh dev 1.0.0 : To use dev configurations
• ./run_docker.sh prod 1.0.0 : To use prod configurations

Logging

This project also uses Log4j2 framework for logging. The configuration for the logging can be found in the log4j2.xml file located in the src/main/resources directory.