AI Finance Platform

Clone the Repository

git clone <repository-url>
cd ai-finance-platform

Install Dependencies

npm install

Configure Environment Variables

• Create a .env (or .env.local) file in the project root.
• Add the required API keys and database credentials, such as:
• Database URL
• Clerk Authentication keys
• AI API key (e.g., Gemini/OpenAI)
• OCR API credentials (if applicable)
• Other required environment variables

Set Up the Database

npx prisma generate
npx prisma migrate dev

Run the Development Server

npm run dev

Open the Application

• Visit http://localhost:3000 in your web browser.

Build for Production (Optional)

npm run build
npm start

1. Sign Up / Log InCreate a new account or log in securely using Clerk Authentication.
2. Complete Your ProfileSet up your account and financial preferences if required.
3. Add Financial TransactionsRecord your income and expenses manually by entering the transaction details.
4. Scan Receipts Using OCRUpload a receipt or bill image.
5. The OCR feature automatically extracts details such as the merchant name, amount, date, and category, allowing you to save the transaction with minimal manual input.
6. Manage BudgetsCreate monthly or custom budgets and monitor your spending against them.
7. View the DashboardAccess real-time charts and summaries to track income, expenses, savings, and overall financial health.
8. Get AI-Powered InsightsReview personalized spending analysis, financial trends, and AI-generated recommendations to improve budgeting and savings.
9. Generate Financial ReportsView monthly and yearly reports to analyze spending patterns and financial performance.
10. Search and Filter TransactionsQuickly find transactions using filters such as date, category, amount, or keyword.
11. Monitor Financial ProgressRegularly check your dashboard and AI insights to stay on track with your financial goals and make informed financial decisions.

Hardware Requirements

• Processor: Intel Core i3 (8th Gen) / AMD Ryzen 3 or higher
• RAM: Minimum 4 GB (8 GB recommended)
• Storage: At least 1 GB of free disk space
• Internet Connection: Required for authentication, AI services, OCR processing, and database connectivity

Software Requirements

• Operating System: Windows 10/11, macOS, or Linux
• Node.js: Version 18.x or later
• npm: Version 9.x or later
• Database: PostgreSQL
• Web Browser: Latest version of Google Chrome, Microsoft Edge, Mozilla Firefox, or Safari
• Code Editor (for development): Visual Studio Code or any modern IDE
• Prisma ORM: For database management and migrations
• Git: For cloning and version control

Required Services / APIs

• Clerk – User authentication and authorization
• Google Gemini/OpenAI API – AI-powered financial insights and recommendations
• OCR Service – Receipt scanning and text extraction (e.g., Tesseract OCR or Google Vision API, depending on your implementation)
• PostgreSQL Database – Store user and transaction data