🏦 MitraBooks - Double-Entry Accounting System

Enterprise-Grade, Scalable Accounting Software for India

---

📋 Table of Contents

• Overview
• Features
• Architecture
• Technology Stack
• Project Structure
• Getting Started
• Development Roadmap
• Contributing

---

🎯 Overview

MitraBooks (मित्र = Friend) is your trusted accounting companion - a modern, scalable double-entry accounting system built specifically for Indian businesses.

Key Highlights

✅ Enterprise-Grade Architecture - Built to scale from 1 to 1,000,000 users
✅ Multi-Tenant - Support multiple companies in single installation
✅ GST Compliant - Built-in GST support for Indian businesses
✅ Real-Time - Instant updates using async architecture
✅ Offline Capable - Desktop app works without internet
✅ Modern UI - Beautiful, intuitive React interface

---

🚀 Features

Phase 1: Core Accounting (Current)

• ✅ Chart of Accounts with hierarchical structure
• ✅ Double-entry bookkeeping engine
• ✅ Journal Entries
• ✅ Multi-company support (Multi-tenant)
• ✅ Audit trail (MongoDB)
• ✅ Role-based access control

Phase 2: Sales & Invoicing (Next)

• 📋 Customer management
• 📋 Invoice creation & management
• 📋 Payment tracking
• 📋 Accounts Receivable aging
• 📋 GST invoicing

Phase 3: Purchase & Expenses

• 📋 Vendor management
• 📋 Bill entry
• 📋 Expense tracking
• 📋 Accounts Payable
• 📋 Payment processing

Phase 4: Inventory Management

• 📋 Product/Item master
• 📋 Stock tracking (FIFO/LIFO/Weighted Average)
• 📋 Purchase orders
• 📋 Stock adjustments
• 📋 Low stock alerts

Phase 5: Reports & Analytics

• 📋 Trial Balance
• 📋 Balance Sheet
• 📋 Profit & Loss Statement
• 📋 Cash Flow Statement
• 📋 GST Reports (GSTR-1, GSTR-3B)
• 📋 Custom reports

Phase 6: Advanced Features

• 📋 Multi-currency support
• 📋 Banking integration
• 📋 Automated reconciliation
• 📋 Budget management
• 📋 Fixed asset management
• 📋 Payroll integration

---

🏗️ Architecture

┌─────────────────────────────────────────────────────────┐
│                     Client Layer                        │
│  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐ │
│  │   Web App    │  │  Desktop App │  │  Mobile App  │ │
│  │   (React)    │  │  (Electron)  │  │ (React Native│ │
│  └──────────────┘  └──────────────┘  └──────────────┘ │
└─────────────────────────────────────────────────────────┘
                            │
                            ▼
┌─────────────────────────────────────────────────────────┐
│                    API Gateway (Nginx)                  │
└─────────────────────────────────────────────────────────┘
                            │
                            ▼
┌─────────────────────────────────────────────────────────┐
│                   Application Layer                      │
│                   FastAPI (Python)                       │
│  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐ │
│  │     Auth     │  │  Accounting  │  │   Reports    │ │
│  │   Service    │  │   Service    │  │   Service    │ │
│  └──────────────┘  └──────────────┘  └──────────────┘ │
└─────────────────────────────────────────────────────────┘
                            │
                            ▼
┌─────────────────────────────────────────────────────────┐
│                    Cache Layer (Redis)                  │
└─────────────────────────────────────────────────────────┘
                            │
                            ▼
┌─────────────────────────────────────────────────────────┐
│                    Data Layer                            │
│  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐ │
│  │  PostgreSQL  │  │   MongoDB    │  │   MinIO/S3   │ │
│  │ (Transactions│  │ (Audit Logs) │  │  (Documents) │ │
│  └──────────────┘  └──────────────┘  └──────────────┘ │
└─────────────────────────────────────────────────────────┘
                            │
                            ▼
┌─────────────────────────────────────────────────────────┐
│              Background Jobs (Celery)                    │
│  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐ │
│  │   Reports    │  │    Emails    │  │   Backups    │ │
│  └──────────────┘  └──────────────┘  └──────────────┘ │
└─────────────────────────────────────────────────────────┘

Why This Architecture Scales

Component	Scalability Strategy
FastAPI	Async/await, handles 10K+ concurrent requests
PostgreSQL	ACID compliance, handles millions of transactions
Redis	In-memory caching, sub-millisecond response
MongoDB	Document storage, horizontal scaling
Celery	Distributed task queue for async operations
Docker	Container orchestration, easy deployment
Kubernetes	Auto-scaling based on load

---

🛠️ Technology Stack

Backend

• FastAPI 0.109+ - Modern, fast web framework
• SQLAlchemy 2.0+ - ORM with async support
• PostgreSQL 15+ - Primary database
• MongoDB 6.0+ - Audit logs & documents
• Redis 7.0+ - Caching & sessions
• Celery 5.3+ - Background tasks
• Alembic - Database migrations

Frontend

• React 18+ - UI library
• TypeScript - Type safety
• Material-UI - Component library
• Redux Toolkit - State management
• Recharts - Data visualization
• Axios - HTTP client

Desktop

• Electron - Cross-platform desktop app

DevOps

• Docker - Containerization
• Docker Compose - Local development
• Kubernetes - Production orchestration
• Nginx - Reverse proxy
• Prometheus - Monitoring
• Grafana - Dashboards

---

📁 Project Structure

mitrabooks/
├── backend/                    # FastAPI backend
│   ├── app/
│   │   ├── api/               # API endpoints
│   │   │   └── v1/
│   │   │       ├── endpoints/ # Route handlers
│   │   │       └── dependencies/ # Dependencies
│   │   ├── core/              # Core configuration
│   │   │   ├── config.py      # Settings
│   │   │   ├── security.py    # Auth & security
│   │   │   └── logging.py     # Logging setup
│   │   ├── models/            # SQLAlchemy models
│   │   │   ├── base.py        # Base model
│   │   │   ├── company.py     # Company (multi-tenant)
│   │   │   ├── account.py     # Chart of Accounts
│   │   │   ├── transaction.py # Journal entries
│   │   │   └── user.py        # User management
│   │   ├── schemas/           # Pydantic schemas
│   │   ├── services/          # Business logic
│   │   ├── db/                # Database configuration
│   │   │   ├── session.py     # PostgreSQL
│   │   │   ├── mongodb.py     # MongoDB
│   │   │   └── redis.py       # Redis
│   │   ├── utils/             # Utility functions
│   │   └── middleware/        # Custom middleware
│   ├── alembic/               # Database migrations
│   ├── tests/                 # Tests
│   └── requirements.txt       # Python dependencies
│
├── frontend/                   # React frontend
│   ├── src/
│   │   ├── components/        # React components
│   │   │   ├── common/        # Shared components
│   │   │   ├── accounting/    # Accounting components
│   │   │   ├── sales/         # Sales components
│   │   │   └── reports/       # Report components
│   │   ├── pages/             # Page components
│   │   ├── services/          # API services
│   │   ├── store/             # Redux store
│   │   ├── hooks/             # Custom hooks
│   │   ├── utils/             # Utilities
│   │   └── types/             # TypeScript types
│   ├── public/                # Static files
│   └── package.json           # NPM dependencies
│
├── desktop/                    # Electron desktop app
│   └── electron/              # Electron configuration
│
├── docker/                     # Docker configuration
│   ├── nginx/                 # Nginx config
│   └── postgres/              # PostgreSQL init scripts
│
├── k8s/                        # Kubernetes manifests
│
├── docs/                       # Documentation
│   ├── api/                   # API documentation
│   ├── user-guide/            # User guides
│   └── developer-guide/       # Developer docs
│
├── scripts/                    # Utility scripts
│
└── docker-compose.yml         # Docker Compose config

---

🚀 Getting Started

Prerequisites

• Python 3.11+
• Node.js 18+
• Docker & Docker Compose
• PostgreSQL 15+
• MongoDB 6.0+
• Redis 7.0+

Quick Start (Docker - Recommended)

# Clone the repository
git clone https://github.com/yourusername/mitrabooks.git
cd mitrabooks

# Copy environment file
cp backend/.env.example backend/.env

# Edit .env with your settings
nano backend/.env

# Start all services with Docker Compose
docker-compose up -d

# Access the application
# Web App: http://localhost:3000
# API Docs: http://localhost:8000/docs

Manual Setup

Backend Setup

# Navigate to backend
cd backend

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Copy environment file
cp .env.example .env

# Edit .env with your database credentials
nano .env

# Run database migrations
alembic upgrade head

# Start development server
uvicorn app.main:app --reload --host 0.0.0.0 --port 8000

Frontend Setup

# Navigate to frontend
cd frontend

# Install dependencies
npm install

# Start development server
npm run dev

Database Initialization

# Create default chart of accounts
python scripts/init_chart_of_accounts.py

# Create admin user
python scripts/create_admin.py

---

🗺️ Development Roadmap

✅ Completed (Current)

• Project structure setup
• Core configuration (settings, database, cache)
• Base models (Company, Account)
• Multi-tenant architecture

🔄 In Progress (Week 1-2)

• Transaction models (Journal Entry, Vouchers)
• User authentication & authorization
• Basic API endpoints (CRUD operations)
• Frontend setup with React
• Basic UI components

📋 Upcoming (Week 3-4)

• Sales module (Customers, Invoices)
• Purchase module (Vendors, Bills)
• Basic reports (Trial Balance, P&L, Balance Sheet)
• Desktop app with Electron

🎯 Future (Month 2-3)

• Inventory management
• GST compliance features
• Advanced reports & analytics
• Multi-currency support
• Mobile app (React Native)

---

📖 Documentation

• API Documentation: Auto-generated at /docs (Swagger UI)
• User Guide: See docs/user-guide/
• Developer Guide: See docs/developer-guide/
• Architecture: See docs/architecture.md

---

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

---

📄 License

This project is licensed under the MIT License - see LICENSE file for details.

---

👥 Team

VittaWorks Technologies

• Building financial solutions for India 🇮🇳

---

📞 Support

• Email: support@mitrabooks.com
• Documentation: https://docs.mitrabooks.com
• GitHub Issues: https://github.com/yourusername/mitrabooks/issues

---

🙏 Acknowledgments

Built with ❤️ for Indian businesses

MitraBooks - Your trusted accounting companion