https://github.com/kushalv238/credit-approval-system
A Django-based Credit Approval System that intelligently determines loan eligibility and offers real-time insights based on past loan data and customer profiles using PostgreSQL.
https://github.com/kushalv238/credit-approval-system
credit-approval credit-approval-system django django-rest-framework docker docker-compose loan-approval loan-approval-system postgresql
Last synced: 13 days ago
JSON representation
A Django-based Credit Approval System that intelligently determines loan eligibility and offers real-time insights based on past loan data and customer profiles using PostgreSQL.
- Host: GitHub
- URL: https://github.com/kushalv238/credit-approval-system
- Owner: kushalv238
- Created: 2024-02-19T11:49:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-11T08:57:44.000Z (11 months ago)
- Last Synced: 2025-04-04T09:36:13.446Z (7 months ago)
- Topics: credit-approval, credit-approval-system, django, django-rest-framework, docker, docker-compose, loan-approval, loan-approval-system, postgresql
- Language: Python
- Homepage:
- Size: 98.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Credit Approval System
This project is a credit approval system that determines loan eligibility based on past loan data. It includes APIs for adding new customers, checking loan eligibility, processing new loans, and viewing loan details.
## Features
- Add a new customer to the customer table
- Check loan eligibility based on credit score
- Process a new loan based on eligibility
- View loan details and customer details
- View all current loan details by customer ID
## Technologies Used
- Django
- PostgreSQL
- Docker
- Docker Compose
## API Endpoints
All APIs run under `/api/v1/`:
1. `/register/`: Add a new customer
2. `/check-eligibility/`: Check loan eligibility based on credit score
3. `/create-loan/`: Process a new loan based on eligibility
4. `/view-loan/loan_id/`: View loan details and customer details by loan ID
5. `/view-loans/customer_id/`: View all current loan details by customer ID
Note: Make sure to add a slash ('/') at the end of the API.
## Pre-requisites
- python
- docker
- Docker Desktop
- docker-compose
## Running the Application
>Clone this project
```bash
git clone https://github.com/kushalv238/credit_approval_system.git
```
>Navigate to the project directory
```bash
cd credit_approval_system
```
>Start the Docker engine by starting the Docker Desktop or by using [OS utilities](https://docs.docker.com/config/daemon/start/)
>Run Docker Compose
```bash
docker-compose up
```
>Access the APIs at
```bash
http://localhost:8000/api/v1/
```
## Testing the project
Use this Postman collection with existing APIs to test the project
[Collection](https://www.postman.com/telecoms-geologist-66457404/workspace/open/collection/26309885-7d351ebb-b7c9-4ee6-8447-239e59c549bc)
Note: Change the agent to [desktop agent](https://www.postman.com/downloads/postman-agent/) if you run Postman on a browser. The option can be found on the bottom right.
## Adding production secrets
Create a ```.env``` file in the root directory of this project & add a [SECRET_KEY](https://docs.djangoproject.com/en/5.0/ref/settings/#secret-key) for django to use.
>Run the following command in your Django project's Python shell to generate a secret key
```bash
from django.core.management.utils import get_random_secret_key
get_random_secret_key()
```
>Copy the new SECRET_KEY that is generated & paste it to your .env file.
```
SECRET_KEY=your_secret_key_here
```
Note: By default this application uses an insecure key please change it to avoid unwanted attacks.
## Author
[Kushal Vadodaria](https://linkedin.com/in/kushal-vadodaria/)