N11 Bootcamp Graduation Project

Hello, this project it was developed in line with The graduation assignment for The bootcamp offered free of charge in partnership with Patika & N11.

Technologies & Structures Used

• Backend
  • Java 11
  • Spring Boot
  • Spring Data JPA
  • Spring HATEOAS
  • MapStruct
  • Loombak
  • Validation
  • Swagger
  • PostgreSQL
  • Unit Test
  • Builder Design Pattern
  • Factory Design Pattern
  • Single Design Pattern
  • Basic Result Type
  • Twilio Sms Send
  • tckimlik.nvi.gov.tr Mernis Check Customer
• Frontend
  • React
  • Axios
  • Reactstrap
  • Formik
  • Yup
  • React Toastify

Setup

*** If You Do Not Have PostgreSQL Installed On Your Computer, You Can Use It Via Docker.

Cloning The Project

$ git clone https://github.com/n11-TalentHub-Java-Bootcamp/n11-talenthub-bootcamp-graduation-project-omerozturk18.git
cd n11-talenthub-bootcamp-graduation-project-omerozturk18/Backend

Configuration Settings

• Open File ./src/main/resources/application.properties .

• Adapt The Following Settings According to Yourself.

  • Replace The 172.25.192.1 Field Below With Your Own Ip Address.

spring.datasource.url=jdbc:postgresql://172.25.192.1:5432/n11-graduation-project
spring.datasource.username=postgres
spring.datasource.password=12345
spring.datasource.driver-class-name=org.postgresql.Driver

• If You Change The database name, username and password and Will Use Docker, Please Also Update The docker-compose.yml Files

1) Backend Setup

mvn clean install

-> Running The Application Locally

• Create a Database named n11-graduation-project in PostgreSQL.

• Run The Application With The Commands Below.

mvn spring-boot:run

-> Running The Application With Docker

• Run The Application With The Commands Below.

docker build -t omerozturk-backend . 

docker-compose up -d

*** If You Want To Use PostgreSQL Over Docker

• Please Follow The Steps Below for PostgreSQL
  • Go to http://localhost:5050/browser/
  • Password is Same as docker-compose.yml
  • Right Click on Servers on The Left and Add a New Server
  • Set a Name on The Screen That Comes Up and Switch To The Connection Tab
  • Just Write Your Ip Address To The Host Address and Save It
  • Create a Database Named n11-graduation-project in PostgreSQL.
  • Run The Application With The Command Below.

docker start omerozturk-app-backend

*** If You Do Have PostgreSQL Installed On Your Computer

• Please Follow The Steps Below
  • Create a Database Named n11-graduation-project in PostgreSQL.
  • Run The Application With The Command Below.

docker start omerozturk-app-backend

2) Frontend Setup

cd n11-talenthub-bootcamp-graduation-project-omerozturk18/Frontend

-> Running The Application Locally

• Install npm packages

npm install

• The Following Code is Used to Start The React Project.

npm start

-> Running The Application With Docker

• Run The Application With The Commands Below.

docker build -t omerozturk-frontend . 
docker-compose up -d

• Frontend Url

Basic Result Type

DataResult

• SuccessDataResult

200 Response body

{
  "success": true,
  "message": "",
  "data": []
}

• SuccessResult

200 Response body

{
  "success": true,
  "message": "sdsd"
}

• ErrorDataResult

Error: response status is 400

{
  "success": false,
  "message": "",
  "data": null
}

• ErrorResult

Error: response status is 400

{
  "success": false,
  "message": "",
}

• NotFoundException

Error: response status is 404

{
  "errorDate": "",
  "message": "",
  "detail": ""
}

ENDPOINTS

Crd Package

• Credit Package

For Credit

• Show Credits : GET /api/credits
• Show Credit : GET /api/credits/{id}
• Show Credit By Credit Name : GET /api/credits/name/{creditName}
• Create Credit : POST /api/credits
• Delete Credit : DELETE /api/credits/{id}

Csr Package

• Customer Package

For Customer

• Show Customers : GET /api/customers
• Show Customer : GET /api/customers/{id}
• Show Customer By Identity Number : GET /api/customers/identityNumber/{identityNumber}
• Create Customer : POST /api/customers
• Update Customer : PUT /api/customers
• Delete Customer : DELETE /api/customers/{id}

For Customer Guarantee

• Show Guarantees : GET /api/guarantees
• ShowGuarantee : GET /api/guarantees/{id}
• Show Customer By Customer Id : GET /api/guarantees/customer/{customerId}
• Create Guarantee : POST /api/guarantees
• Create Guarantees : POST /api/guarantees/all
• Delete Guarantee : DELETE /api/guarantees/{id}

For Customer Credit

• Show Customer Credits : GET /api/customer-credits
• Show Customer Credit : GET /api/customer-credits/{id}
• Show Customer Credits By Customer Id : GET /api/customer-credits/customer/{customerId}
• Show Customer Credits By Credit Id : GET /api/customer-credits/credit/{creditId}
• Show Customer Credit Result : GET /api/customer-credits/credit-result/{identityNumber}/{dateOfBirth}
• Show Customer Credit Result Approved : GET /api/customer-credits/credit-result-approved/{identityNumber}/{dateOfBirth}
• Show Customer Credit Active Credit By Customer : GET /api/customer-credits/active-credits-customer/{customerId}
• Create Customer Credit Apply : POST /api/customer-credits
• Put Customer Credit Response : POST /api/customer-credits
• Delete Customer Credit : DELETE /api/customer-credits/{id}

Cnt Package

• Contact Package

For Message

• Show Messages : GET /api/messages
• Show Message : GET /api/messages/{id}
• Show Message By Phone Number : GET /api/messages/phone/{phoneNumber}
• Create Message : POST /api/messages
• Delete Message : DELETE /api/messages/{id}

Gen Package

• Generic Package

• Adapter

  • Credit Score Service
  • Mernis Service
  • Twilio Sms Service

• Configuration

  • SwaggerConfiguration
  • TwilioConfiguration

• Excaption

  • CustomizedResponseEntityExceptionHandler
  • ExceptionResponse

• Utilities

  • Entity

    • BaseEntity
    • SmsRequest

  • Enums

    • EnumStatus
    • EnumYesNo

  • Result

    • Result
      • SuccessResult
      • ErrorResult
    • DataResult
      • SuccessDataResult
      • ErrorDataResult

  • Service

    • BaseEntityService
      • findAll
      • findById
      • save
      • delete

Uml Diagram

• Show Crd Package Uml Diagram
• Show Csr Package Uml Diagram
• Show Cnt Package Uml Diagram

OpenApi Swagger

• Show OpenApi Yaml File

• Show OpenApi Json File

• You Can Access Swagger Here When The App Is Running

Author

Ömer Öztürk

• github/omerozturk18