README.md

Credit Request System API

Rest API created for a fictitious lending company where the objective is to manage customers and credit requests.

Table of Contents

1. Concept
   • Business rules
   • Database model
   • Project architecture
2. Getting Started
   • Prerequisites
   • Installation
   • How to run
3. Collection
4. References

Concept

In addition to customer management, the system must be able to perform a new credit request, list all credit requests for a given customer and detail a specific credit request.

Business rules

• Number of installments must be between 1 and 48.
• Max day of first installment is 3 months in the future from today.
• Only the client who request the credit can get credit request details.

Database model

The entity relation that determines the logical structure of a database.

Project architecture

The project is organized in a three layers architecture.

Getting Started

Prerequisites

Get Java17 installed in your environment.

Important: Make sure that your JAVA_HOME environment variable is correctly exported

Installation

1. Clone the repo:

git clone https://github.com/barreto/credit-request-system

2. Enter the application directory:

cd credit-request-system

3. Set the database environment variables

    db_username=<username>
    db_password=<password>

Both of these variables will be used for the H2, an inmemory database, so you don't need to configure it.

How to run

Using inproject gradle:

./gradlew bootRun

Collection

Download and import the collection file in your Insomnia to enjoy this API.

References

• Thanking: This project was created during a DIO bootcamp.

• Original repository: credit-application-system by Camila Cavalcante.

• Initial structure: This project start with configurations that can be loaded on spring initializr link.

back to top ↑