FinInsRAG-V3 Local Study Notes

This repository is a personal local deployment and learning record for an industrial RAG practice project from coursework. It is not presented as a fully original project. The code and notes are organized for review, reproduction, and later iteration in a private/local learning context.

Scope

• Backend: FastAPI service, PostgreSQL, Elasticsearch, Redis, document parsing, retrieval, and chat APIs.
• Frontend: Vite + React client for login, repository management, and chat.
• Deployment: Docker Compose based local backend stack plus local frontend dev server.

Security Notes

The repository intentionally excludes local secrets and runtime data:

• .env files and private keys
• uploaded documents and source data files
• Docker volumes and local database files
• node_modules, Python virtual environments, caches, logs, and __pycache__

Use .env.example and backend/.env.example as templates. Copy them to local .env files and fill in your own values before running the project.

Backend

cd backend
copy .env.example .env
docker compose up -d --build

Common local logs:

docker logs -f swxy_api

Frontend

cd frontend
npm install
npm run dev

Default local access:

http://localhost:5181/

Notes

Deployment notes are kept in docs/deployment-notes.md. Real documents used for retrieval experiments should stay outside Git or under ignored local data/upload directories.