跳到正文

imchine

FinTech-Solution

FinTech AI Solution for SMEs to calculate financial values

README 已保存到本站,可直接阅读

Documentation snapshot

README 快照

这篇是英文原文

下面正文是项目自己的英文 README。想读全文就用浏览器自带的整页翻译: Chrome / Edge 点地址栏右侧的翻译图标,或用右键菜单里的「翻译成中文」; 手机浏览器一般在菜单里。

本页保存的是公开项目资料快照,阅读过程不需要连接 GitHub。

FinSight AI — AI Financial Assistant for SMEs

Production-grade SaaS financial intelligence platform powered by GPT-4o, Next.js 15, and PostgreSQL.

图片:Next.js 图片:TypeScript 图片:PostgreSQL 图片:Clerk 图片:OpenAI


🚀 Features

Core Modules

ModuleDescription
Financial DashboardReal-time revenue, expenses, profit, invoice metrics
Invoice ManagementCreate, send, track, record payments
Expense TrackingManual entry, CSV import, categorization
Transaction LedgerFull double-entry transaction history
Bank Statement AnalyzerUpload PDF/CSV, extract & categorize transactions
AI Financial AssistantRAG-based chatbot with real financial data context
AI Insights EngineAuto-detected anomalies, risks, opportunities
Cash Flow ForecastingDeterministic 3-month linear trend forecasts
Financial ReportsP&L, Expense Summary, Revenue Trends (PDF/Excel)
Settings & SecurityRBAC, audit logs, MFA, organization management

Critical Design Principle

AI NEVER calculates financial values. All calculations are deterministic and performed by the backend using Prisma queries. AI only generates explanations, insights, and narratives based on the pre-calculated data.


🏗️ Architecture

┌─────────────────────────────────────────────────────────┐
│                    Next.js 15 App Router                 │
├──────────────────────┬──────────────────────────────────┤
│   Frontend (RSC)     │        API Routes                 │
│  - Dashboard         │  - /api/dashboard                 │
│  - Invoices          │  - /api/invoices                  │
│  - Expenses          │  - /api/expenses                  │
│  - AI Assistant      │  - /api/ai/chat (SSE streaming)   │
│  - Cash Flow         │  - /api/cash-flow                 │
│  - Reports           │  - /api/reports                   │
│  - Insights          │  - /api/insights                  │
└──────────────────────┴──────────────────────────────────┘
           │                          │
    Clerk Auth                  Prisma ORM
           │                          │
    PostgreSQL DB              OpenAI GPT-4o
           │                          │
    Qdrant Vector DB         RAG Pipeline

RAG Pipeline

User Question
→ Intent Classification (GPT-4o-mini)
→ Data Retrieval (Prisma queries = REAL numbers)
→ Context Assembly
→ OpenAI GPT-4o Response Generation
→ Streaming SSE to Frontend

📋 Tech Stack

Frontend

  • Next.js 15 (App Router, RSC, Streaming)
  • TypeScript 5
  • Tailwind CSS + ShadCN UI components
  • Recharts (interactive financial charts)
  • React Query (server state management)
  • Zustand (client state)

Backend

  • Next.js API Routes
  • Prisma ORM with PostgreSQL
  • Zod validation (all inputs)
  • Rate limiting via Redis when REDIS_URL is set (in-process fallback otherwise)
  • Redis-backed dashboard metrics cache with version invalidation on writes

AI

  • OpenAI GPT-4o (assistant responses)
  • OpenAI text-embedding-3-small (embeddings)
  • RAG architecture for financial context
  • Qdrant vector database

Auth & Security

  • Clerk Authentication (OAuth, MFA, RBAC)
  • OWASP Top 10 compliant
  • CSRF protection in middleware
  • SQL injection prevention (Prisma parameterized queries)
  • Complete audit logging

🗄️ Database Schema

Organizations ──┬── OrganizationMembers ── Users
                ├── Clients
                ├── Vendors
                ├── Categories
                ├── Transactions ── Categories
                ├── Invoices ─────┬── InvoiceItems
                │                 └── Payments
                ├── Expenses ── Categories
                ├── BankStatements ── Transactions
                ├── Reports
                ├── AIChats ── AIChatMessages
                ├── Insights
                ├── CashFlowForecasts
                ├── Notifications
                ├── AuditLogs
                └── Anomalies

🔒 Security Implementation

Security LayerImplementation
AuthenticationClerk JWT + MFA
AuthorizationRBAC (Admin/Accountant/Employee/Viewer)
CSRF ProtectionOrigin/Host validation in middleware
Rate LimitingPer-IP sliding window (100 req/min default)
Input ValidationZod schemas on all API endpoints
SQL InjectionPrisma ORM parameterized queries
XSS PreventionNext.js built-in + CSP headers
Audit LoggingAll CRUD operations logged with user/IP
Sensitive DataPrisma field-level encryption ready
File UploadType validation, size limits, S3 signed URLs

🚀 Quick Start

Prerequisites

  • Node.js 20+
  • PostgreSQL 16+
  • OpenAI API key
  • Clerk account

1. Clone & Install

git clone https://github.com/imchine/FinTech-Solution.git
cd finsight-ai
npm install

2. Environment Setup

cp .env.example .env.local
# Fill in your API keys

3. Database Setup

# Apply schema
npx prisma migrate dev --name init

# Generate client
npx prisma generate

4. Run Development

npm run dev
# Open http://localhost:3000

5. Docker (Full Stack)

docker-compose up -d

Redis (optional)

Redis is optional but recommended for production and multi-instance deployments.

docker compose up -d redis
# set in .env.local:
REDIS_URL=redis://localhost:6379

When REDIS_URL is set:

  • Rate limiting — shared across API routes (/api/transactions, /api/invoices, /api/ai/chat, etc.)
  • Dashboard cache — metrics cached for 2 minutes; invalidated when transactions, expenses, or invoices change
  • Health check — GET /api/health reports whether Redis is configured

Without Redis, rate limits and dashboard metrics use in-process behaviour only.


📁 Folder Structure

finsight-ai/
├── src/
│   ├── app/
│   │   ├── (auth)/          # Sign in/up pages (Clerk)
│   │   ├── (dashboard)/     # All protected dashboard pages
│   │   │   ├── dashboard/   # Main financial dashboard
│   │   │   ├── invoices/    # Invoice management
│   │   │   ├── expenses/    # Expense tracking
│   │   │   ├── transactions/# Transaction ledger
│   │   │   ├── ai-assistant/# AI chatbot interface
│   │   │   ├── cash-flow/   # Cash flow & forecasting
│   │   │   ├── insights/    # AI insights engine
│   │   │   ├── reports/     # Financial reports
│   │   │   ├── bank-statements/ # Bank statement analyzer
│   │   │   └── settings/    # Account & org settings
│   │   └── api/             # All API routes
│   ├── components/
│   │   ├── ui/              # ShadCN UI components
│   │   ├── charts/          # Recharts wrappers
│   │   ├── dashboard/       # Dashboard-specific components
│   │   ├── layout/          # Sidebar, Header
│   │   └── shared/          # Providers, theme
│   ├── lib/
│   │   ├── prisma.ts        # Database client
│   │   ├── auth.ts          # Auth helpers & audit logging
│   │   ├── openai.ts        # AI integration & RAG
│   │   ├── financial-calculations.ts  # ALL financial math
│   │   ├── validations.ts   # Zod schemas
│   │   ├── rate-limit.ts    # API rate limiting
│   │   └── utils.ts         # Utilities & formatters
│   ├── middleware.ts         # Auth & security middleware
│   └── types/               # TypeScript types
├── prisma/
│   └── schema.prisma        # Complete DB schema
├── docker-compose.yml       # Full stack Docker setup
├── Dockerfile               # Production container
└── .env.example             # Environment template

📊 API Endpoints

MethodEndpointDescription
GET/api/healthHealth check
GET/api/dashboardDashboard metrics
GET/api/dashboard/trendsMonthly trends
GET/api/dashboard/categoriesExpense categories
GET/POST/api/invoicesList/create invoices
GET/PATCH/DELETE/api/invoices/[id]Invoice operations
GET/POST/api/expensesList/create expenses
GET/POST/api/transactionsList/create transactions
POST/api/ai/chatAI chat (SSE streaming)
GET/api/ai/chatChat history
GET/api/cash-flowHistorical + forecasts
GET/POST/api/reportsReport management
GET/api/insightsAI insights

🚢 Deployment

Vercel (Frontend)

vercel deploy --prod

Environment Variables (Production)

Set all variables from .env.example in your deployment platform.

Database Migration (Production)

npx prisma migrate deploy

🧪 Testing Strategy

  • Unit Tests: Financial calculation functions (Jest)
  • Integration Tests: API routes with Prisma mocks
  • E2E Tests: Playwright for critical user flows
  • Security Tests: OWASP ZAP scanning
  • Load Tests: k6 for API performance

📈 Performance

  • Server-side rendering for initial dashboard load
  • React Query caching (60s stale time)
  • Optimized Prisma queries with proper indexes
  • Streaming AI responses (SSE)
  • Image optimization via Next.js
  • Lazy loading of chart components

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make changes with tests
  4. Submit a PR

📄 License

MIT License — see LICENSE file.


Built with ❤️ for SMEs worldwide

Official distribution

获取与安装

暂未发现可确认的官方软件包地址

当前 README 快照没有出现 npm、PyPI、Crates.io、pub.dev 等官方包页链接。本站不会根据仓库名称猜测下载地址。

本站不托管项目文件;需要安装时,请以项目维护者发布的官方文档为准。

使用前核验

本站保存公开资料用于阅读,不代表安全审计或功能背书。安装前请核对许可证、依赖来源和发布签名,不要直接运行来源不明的二进制文件或高权限脚本。