Skip to content

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
    • Help
    • Submit feedback
    • Contribute to GitLab
  • Sign in
F
finwise-miniapp-be
  • Project
    • Project
    • Details
    • Activity
    • Releases
    • Cycle Analytics
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Charts
  • Issues 0
    • Issues 0
    • List
    • Board
    • Labels
    • Milestones
  • Merge Requests 0
    • Merge Requests 0
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Charts
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Charts
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • ThinhNC
  • finwise-miniapp-be
  • Merge Requests
  • !35

Merged
Opened Aug 24, 2026 by ThinhNC@ThinhNC
  • Report abuse
Report abuse

docs(be): update comprehensive README with layered architecture, 24 modules, and API reference

Key Changes & Additions

Backend (finwise-miniapp-be/README.md)

  • Layered Architecture & Invariants: Documented the strict Route -> Validation -> Controller -> Service -> Repository -> Database flow, ACID balance invariants, UTC+7 Asia/Ho_Chi_Minh timezone boundary rules, and the Zero Hallucination AI DSL policy.
  • 24 Complete Modules & API Reference: Comprehensive reference table of all /api/v1/... endpoints across Auth, Dynamic RBAC 2.0, Audit Logs, Wallets, Transactions, Cash Flow Forecast, Anomaly Detection, Subscriptions, Developer API Keys, Webhooks, and Cloudflare R2 Uploads.
  • Infrastructure & Caching: Detailed Redis distributed locking (ioredis), background cron/worker architecture, and Google Gemini AI token usage tracking.
  • Environment & Setup: Full table of environment variables, seed credentials (admin@finwise.local, etc.), Jest/Supertest testing commands, and Docker Compose / PM2 deployment guides.

Monorepo Root (README.md)

  • Created an overarching repository README connecting frontend, backend, deep-dive architecture docs, ERD references, and quickstart commands.

Check out, review, and merge locally

Step 1. Fetch and check out the branch for this merge request

git fetch origin
git checkout -b docs/update-comprehensive-readme origin/docs/update-comprehensive-readme

Step 2. Review the changes locally

Step 3. Merge the branch and fix any conflicts that come up

git fetch origin
git checkout origin/develop
git merge --no-ff docs/update-comprehensive-readme

Step 4. Push the result of the merge to GitLab

git push origin develop

Note that pushing to GitLab requires write access to this repository.

Tip: You can also checkout merge requests locally by following these guidelines.

  • Discussion 0
  • Commits 1
  • Changes 1
Assignee
No assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
0
Labels
None
Assign labels
  • View project labels
Reference: ThinhNC/finwise-miniapp-be!35

Revert this merge request

This will create a new commit in order to revert the existing changes.

Switch branch
Cancel
A new branch will be created in your fork and a new merge request will be started.

Cherry-pick this merge request

Switch branch
Cancel
A new branch will be created in your fork and a new merge request will be started.