Personal Loan Proposal Management System

The project is organized in two folders, frontend (React + Vite + TypeScript) and backend (Django + PostgreSQL + RabbitMQ).

To run the backend you must use docker compose

docker compose up -d

• Default frontend url: http://localhost:8080/
• Default backend url: http://localhost:8000/api/

Next go to Swagger Api doc in http://localhost:8000/api/docs/ for the api definitions and explication

• The program will load some data for testing like one user account.

• No authentication required for endpoints

• User credentials for Django Admin:

  • username: proposal_admin
  • password: proposal_admin

• Example Request:

  curl --request GET 'http://localhost:8000/api/v1/proposals/fields/' \
      --header 'Content-Type: application/json'
  

  • Example Response: [{"uuid":"1c6f2eec-4d67-483d-8770-df22159e7de4","name":"CPF","slug":"cpf","type":"text","required":true,"is_active":true}]

This project provide an API for managing loan proposals. It offers the following features:

• Get proposal fields
• Create a new loan proposal
• Background proposal analysis with Celery
• Django Admin Management Interface

Test command for backend

docker compose run proposal_backend python3 manage.py test apps

Notes

• The frontend is a simple form interface that generates the fields based on what it collects from the fields created in the API.
• We used a single 'main' branch for the development of the project because it was a simple task and for testing purposes, which is not recommended to work in larger and production environments, should manage one or several development branches and gradually incorporate the changes. already tested to the main branch.
• The API has unit and integration tests to ensure correct operation and validation of inputs and different cases.