🛠️ Developer Documentation
Welcome to the technical documentation for the NBFC Investment Management Platform. This guide covers architecture, APIs, database schemas, and extension patterns.
📌 For Developers Only
This documentation is intended for software developers working on the platform
codebase. For user guides, please refer to the separate User Documentation portal.
Quick Navigation
System Architecture
High-level architecture, tech stack, module structure, and deployment patterns.
Database Reference
MongoDB schemas, collections, indexes, and data relationships.
API Reference
Complete REST API documentation with 200+ endpoints.
Extending the System
How to add new modules, screens, and database collections.
Tech Stack
| Layer | Technology | Version |
|---|---|---|
| Backend | Fastify (Node.js) | 4.x |
| Database | MongoDB | 7.x |
| Cache | Redis | 7.x |
| Frontend | Next.js + React | 14.x |
| Mobile | Flutter | 3.x |
| Auth | JWT + TFA | - |
Getting Started
Prerequisites
- Node.js 20+ with pnpm
- MongoDB 7+ (local or Atlas)
- Redis 7+ (local or managed)
- Flutter SDK 3.x (for mobile development)
Local Development Setup
# Clone repositories
git clone [your-backend-repo]
git clone [your-frontend-repo]
git clone [your-mobile-repo]
# Backend setup
cd backend
cp .env.example .env
pnpm install
pnpm dev
# Frontend setup
cd frontend
pnpm install
pnpm dev
# Mobile setup
cd mobile
flutter pub get
flutter run
⚠️ Environment Variables
Never commit
.env files. Use environment-specific configurations and secrets management
for production.
Contact
- Slack: #dev-platform
- Email: Contact your team lead
- Docs Issues: File in the documentation repository