Skip to content

vedantCE/Know_Your_Credit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

40 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🏦 Know Your Credit - Comprehensive Credit Management Platform

A full-stack web application for credit score management, loan applications, and comprehensive financial guidance with AI-powered assistance.

Know Your Credit Version License

🌟 Features

πŸ“Š Credit Score Management

  • Multi-Bureau Credit Scores: View scores from CIBIL, Experian, Equifax, and CRIF
  • Animated Speedometer Gauges: Interactive visual representation of credit scores
  • Credit History Tracking: 4-week trend analysis with detailed breakdown
  • Personalized Score Generation: Dynamic scoring based on user profile
  • Score Improvement Tips: Actionable advice for credit enhancement

πŸ’° Loan Management System

  • Recommended Loans: Personalized loan suggestions based on credit score
  • Multiple Loan Types: Personal, Home, Car, and Business loans
  • Loan Application Flow: Complete application process with autofill
  • Application Tracking: Real-time status updates and notifications
  • Risk Assessment: AI-powered loan eligibility and risk analysis
  • EMI Calculator: Built-in calculator for loan planning

πŸ€– AI-Powered Financial Assistant

  • Comprehensive Finance Knowledge: Covers all financial topics
  • Gemini AI Integration: Advanced AI responses for complex queries
  • Smart Fallback System: Detailed responses even without AI
  • Personalized Advice: Context-aware recommendations
  • 24/7 Availability: Always available financial guidance

πŸ‘€ User Management

  • Complete Profile System: Personal, employment, and banking details
  • Multi-Bank Support: Add multiple bank accounts
  • Profile Validation: Comprehensive form validation
  • Secure Authentication: JWT-based authentication system
  • Admin Dashboard: Employee management and user oversight

πŸ“± Modern UI/UX

  • Responsive Design: Works on all devices
  • Modern Components: Built with Radix UI and Tailwind CSS
  • Smooth Animations: Framer Motion animations
  • Interactive Charts: Recharts for data visualization
  • Professional Theme: Blue-themed professional interface

πŸ› οΈ Technology Stack

Frontend

  • React 19.1.1 - Modern React with latest features
  • Vite - Fast build tool and development server
  • Tailwind CSS 4.1.11 - Utility-first CSS framework
  • Radix UI - Accessible component library
  • Framer Motion - Animation library
  • Recharts - Chart library for data visualization
  • React Router DOM - Client-side routing
  • Lucide React - Icon library

Backend

  • Node.js - JavaScript runtime
  • Express.js 5.1.0 - Web framework
  • MongoDB - NoSQL database
  • Mongoose 8.18.0 - MongoDB object modeling
  • Google Generative AI - AI integration for chatbot
  • Nodemailer - Email service
  • CORS - Cross-origin resource sharing
  • dotenv - Environment variable management

Development Tools

  • ESLint - Code linting
  • Nodemon - Development server auto-restart
  • Vite - Build tool and dev server

πŸš€ Quick Start

Prerequisites

  • Node.js (v16 or higher)
  • MongoDB (local or cloud)
  • Google Gemini API key

Installation

  1. Clone the repository
git clone https://github.com/yourusername/know-your-credit.git
cd know-your-credit
  1. Install Backend Dependencies
cd server
npm install
  1. Install Frontend Dependencies
cd ../Frontend
npm install
  1. Environment Setup

Create .env file in server directory:

PORT=3001
MONGODB_URI=mongodb://localhost:27017/know-your-credit
GEMINI_API_KEY=your_gemini_api_key_here
JWT_SECRET=your_jwt_secret_here
EMAIL_USER=your_email@gmail.com
EMAIL_PASS=your_app_password

Create .env file in Frontend directory:

VITE_BACKEND_URL=http://localhost:3001
  1. Start the Application

Backend:

cd server
npm run dev

Frontend (in new terminal):

cd Frontend
npm run dev
  1. Access the Application

πŸ“ Project Structure

Know_Your_Credit/
β”œβ”€β”€ Frontend/                 # React frontend application
β”‚   β”œβ”€β”€ public/              # Static assets
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ components/      # Reusable UI components
β”‚   β”‚   β”‚   β”œβ”€β”€ ui/         # Base UI components (Radix UI)
β”‚   β”‚   β”‚   β”œβ”€β”€ AnimatedSpeedometer.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ ChatBot.jsx
β”‚   β”‚   β”‚   └── modals/     # Modal components
β”‚   β”‚   β”œβ”€β”€ pages/          # Page components
β”‚   β”‚   β”‚   β”œβ”€β”€ UserDashboard.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ AdminDashboard.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ SignIn.jsx
β”‚   β”‚   β”‚   └── SignUp.jsx
β”‚   β”‚   β”œβ”€β”€ hooks/          # Custom React hooks
β”‚   β”‚   β”œβ”€β”€ lib/            # Utility functions and API
β”‚   β”‚   └── App.jsx         # Main app component
β”‚   β”œβ”€β”€ package.json
β”‚   └── vite.config.js
β”œβ”€β”€ server/                  # Node.js backend
β”‚   β”œβ”€β”€ models/             # MongoDB models
β”‚   β”‚   β”œβ”€β”€ Employee.js
β”‚   β”‚   β”œβ”€β”€ LoanApplication.js
β”‚   β”‚   └── Notification.js
β”‚   β”œβ”€β”€ routes/             # API routes
β”‚   β”‚   β”œβ”€β”€ chat.js         # AI chatbot endpoints
β”‚   β”‚   β”œβ”€β”€ employees.js    # Employee management
β”‚   β”‚   β”œβ”€β”€ bureau.js       # Credit bureau APIs
β”‚   β”‚   └── otp.js          # OTP verification
β”‚   β”œβ”€β”€ services/           # Business logic services
β”‚   β”‚   β”œβ”€β”€ bureauService.js
β”‚   β”‚   β”œβ”€β”€ emailService.js
β”‚   β”‚   └── otpService.js
β”‚   β”œβ”€β”€ index.js            # Server entry point
β”‚   └── package.json
└── README.md

πŸ”§ API Endpoints

Authentication

  • POST /register - User registration
  • POST /login - User login
  • POST /verify-otp - OTP verification

User Management

  • GET /users - Get all users (admin)
  • PUT /users/:id - Update user
  • DELETE /users/:id - Delete user
  • POST /search-users - Search users

Loan Applications

  • POST /loan-applications - Submit loan application
  • GET /loan-applications/:userId - Get user's applications
  • DELETE /loan-applications/:id - Remove application

AI Chat

  • POST /api/chat - Send message to AI assistant

Notifications

  • GET /notifications/:userId - Get user notifications
  • PUT /notifications/:id/read - Mark notification as read

🎯 Key Features Explained

Credit Score System

  • Dynamic Generation: Scores generated based on user profile (income, occupation, name seed)
  • Multi-Bureau Display: Shows scores from 4 major credit bureaus
  • Historical Tracking: 4-week trend with detailed change explanations
  • Visual Representation: Animated speedometer gauges with color coding

Loan Application Flow

  1. Profile Completion: Users must complete profile before applying
  2. Loan Selection: Choose from recommended loans based on credit score
  3. Auto-fill Application: Profile data automatically populates forms
  4. Application Preview: Review before submission
  5. Status Tracking: Real-time updates and notifications
  6. Receipt Generation: Printable application receipts

AI Financial Assistant

  • Comprehensive Knowledge: Covers credit, loans, investments, insurance, tax planning
  • Indian Financial Context: Specific to Indian banking and regulations
  • Personalized Responses: Uses user's credit score and profile
  • Fallback System: Smart responses even when AI is unavailable
  • Multi-topic Support: Handles all finance-related queries

Admin Dashboard

  • User Management: View, edit, and manage all users
  • Application Oversight: Monitor all loan applications
  • Search Functionality: Find users and applications quickly
  • Analytics: User signup trends and statistics

πŸ”’ Security Features

  • JWT Authentication: Secure token-based authentication
  • Input Validation: Comprehensive form validation
  • Environment Variables: Sensitive data protection
  • CORS Configuration: Secure cross-origin requests
  • Data Sanitization: Protection against injection attacks

πŸ“± Responsive Design

  • Mobile-First: Optimized for mobile devices
  • Tablet Support: Perfect tablet experience
  • Desktop Enhanced: Full desktop functionality
  • Cross-Browser: Compatible with all modern browsers

🎨 UI/UX Features

  • Professional Theme: Blue-based color scheme
  • Smooth Animations: Framer Motion powered
  • Interactive Elements: Hover effects and transitions
  • Accessibility: ARIA compliant components
  • Loading States: Proper loading indicators
  • Error Handling: User-friendly error messages

πŸš€ Deployment

Frontend Deployment (Vercel/Netlify)

  1. Build the project: npm run build
  2. Deploy the dist folder
  3. Set environment variables in deployment platform

Backend Deployment (Railway/Heroku)

  1. Set up MongoDB Atlas
  2. Configure environment variables
  3. Deploy using platform-specific instructions

Environment Variables for Production

# Backend
PORT=3001
MONGODB_URI=mongodb+srv://username:password@cluster.mongodb.net/dbname
GEMINI_API_KEY=your_production_gemini_key
JWT_SECRET=your_strong_jwt_secret
EMAIL_USER=your_production_email
EMAIL_PASS=your_production_app_password

# Frontend
VITE_BACKEND_URL=https://your-backend-domain.com

πŸ§ͺ Testing

Frontend Testing

cd Frontend
npm run lint

Backend Testing

cd server
npm test

πŸ“ˆ Performance Optimization

  • Code Splitting: Lazy loading of components
  • Image Optimization: Optimized assets
  • Bundle Analysis: Vite bundle optimization
  • Caching: Proper HTTP caching headers
  • Database Indexing: MongoDB performance optimization

🀝 Contributing

  1. Fork the repository
  2. Create feature branch: git checkout -b feature/new-feature
  3. Commit changes: git commit -am 'Add new feature'
  4. Push to branch: git push origin feature/new-feature
  5. Submit pull request

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ‘₯ Team

  • Frontend Developer: React, UI/UX Design
  • Backend Developer: Node.js, API Development
  • AI Integration: Gemini AI Implementation
  • Database Design: MongoDB Schema Design

πŸ”„ Version History

  • v1.0.0 - Initial release with full feature set
  • v0.9.0 - Beta release with core features
  • v0.8.0 - Alpha release with basic functionality

🎯 Future Enhancements

  • Mobile app development
  • Advanced analytics dashboard
  • Integration with more credit bureaus
  • Blockchain-based credit verification
  • Machine learning credit predictions
  • Multi-language support
  • Advanced financial planning tools

About

Know Your Credit

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages