# santoshvandari/accountingsystem architecture

> Architecture diagram of the GitHub repository santoshvandari/accountingsystem, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/santoshvandari/accountingsystem
- Repository: https://github.com/santoshvandari/accountingsystem

## Overview

##### Project Type and Purpose
- This is a full-stack Accounting System.
- Backend: Django 5 + Django REST Framework (DRF) providing a JWT-secured REST API (accounts, transactions, billing).
- Frontend: React (Vite + Tailwind) as a single-page app (SPA) with role-based UI (admin, manager, cashier), charts, and invoicing.

##### File-Structure Analysis
- Top level:
- backend/ – Django project
– core/ (settings, URL routing, permissions)
– accounts/ (custom user model, auth, RBAC)
– transactions/ (CRUD)
– billing/ (invoicing, PDF/print endpoints)
– manage.py, requirements.txt
- frontend/ – React app
– src/api (base API client, endpoint index)
– src/contexts (AuthContext for JWT storage)
– src/components (UI library: Buttons, Tables, Modals, etc.)
– src/pages (Dashboard, Transactions, Bills, Users, Settings, Login)
– vite.config.js, .env.example
- docs/ – MARKDOWN docs (API.md, ARCHITECTURE.md, DEVELOPER_GUIDE.md)

##### README Insights
- Stated features: JWT auth, role-based permissions, transactions, invoicing with PDF print, dashboard charts.
- Tech stack: DRF + simplejwt + drf-yasg, SQLite (dev)/Postgres (prod), React 19 + Tailwind 4 + Recharts.
- Architecture & API documented under docs/.

##### Main Components
a. User / Browser
– Web browser making HTTP/HTTPS requests
b. Frontend (React SPA)
– Vite dev server / static hosting
– AuthContext + localStorage for JWT
– API client (base.js) for attaching JWT
– Pages & UI components (Dashboard, Transactions, Bills, etc.)
c. API Gateway / Django REST Backend
– core/ (URL routing, global permissions)
– accounts/, transactions/, billing/ apps with Models → Serializers → Views → URLs
– simplejwt for token generation/validation
– drf-yasg providing Swagger/OpenAPI at `/docs/`
d. Database
– SQLite in development, Postgres in production
e. External Services
– PDF generation (e.g., wkhtmltopdf or frontend print-to-PDF)
– Email/SMS (if billing notifications are added)
– CDN or Object Storage for static assets (optional)

##### Component Relationships & Data Flow
- Browser → (login request) → React → POST `/api/token/` → Django → simplejwt → issues JWT → returned to React → stored in AuthContext.
- For protected routes: React → GET/POST `/api/transactions/`, `/api/billing/` → JWT in Authorization header → Django verifies → performs DB operations → returns JSON.
- Billing PDF: React requests invoice → Django generates PDF or JSON payload → React triggers browser print or calls third-party PDF service.
- Swagger UI: Browser → GET `/docs/` → Django/drf-yasg → renders OpenAPI docs.

##### Architectural Patterns & Design Principles
- Separation of concerns:
- Frontend (UI & client-side state) vs. Backend (business logic & data).
- Django apps per domain (accounts, transactions, billing).
- RESTful API: Resources modeled via serializers and viewsets.
- Component-based UI in React.
- Context API for global auth state.
- Environment-based configuration (dev vs. prod database, CORS, ALLOWED_HOSTS).

##### Detailed Elements to Capture
- Frontend: AuthContext → API client → UI pages.
- Backend apps: core URLs → app viewsets → serializers → models → database.
- JWT auth flow.
- API documentation endpoint.
- Environment variable configuration points (VITE_API_URL, SECRET_KEY, DATABASE_URL).
- Optionally, CI/CD or containerization if used (not in current tree).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend Layer"
        ReactSPA["React SPA (Vite + Tailwind)"]:::frontend
        AuthContext["AuthContext (JWT Storage)"]:::frontend
        APIClient["API Client (base.js)"]:::frontend
        APIIndex["API Endpoints Index"]:::frontend
        UIComponents["UI Components"]:::frontend
        Pages["Pages (Dashboard, Transactions, etc.)"]:::frontend
        ViteConfig["Vite Config"]:::frontend
        EnvExample[".env.example"]:::frontend
        BrowserStorage["Browser Storage Helper"]:::frontend
        AppEntry["App Entry (App.jsx)"]:::frontend
        MainEntry["Main Entry (main.jsx)"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend Layer"
        DjangoREST["Django REST (DRF + simplejwt)"]:::backend
        CoreSettings["core/settings.py"]:::backend
        CoreURLs["core/urls.py"]:::backend
        CorePermissions["core/permissions.py"]:::backend
        ASGI["core/asgi.py"]:::backend
        WSGI["core/wsgi.py"]:::backend
        AccountsModels["accounts/models.py"]:::backend
        AccountsManager["accounts/manager.py"]:::backend
        AccountsSerializers["accounts/serializers.py"]:::backend
        AccountsViews["accounts/views.py"]:::backend
        AccountsURLs["accounts/urls.py"]:::backend
        AccountsUtils["accounts/utils.py"]:::backend
        TransactionsModels["transactions/models.py"]:::backend
        TransactionsSerializer["transactions/serializer.py"]:::backend
        TransactionsViews["transactions/views.py"]:::backend
        TransactionsURLs["transactions/urls.py"]:::backend
        BillingModels["billing/models.py"]:::backend
        BillingSerializers["billing/serializers.py"]:::backend
        BillingViews["billing/views.py"]:::backend
        BillingURLs["billing/urls.py"]:::backend
        SwaggerUI["Swagger UI (/docs/)"]:::backend
    end

    %% Database
    Database["Database (SQLite/Postgres)"]:::database

    %% External Services
    PDFService["PDF Service"]:::external
    CDN["CDN / Object Storage"]:::external

    %% Flow Arrows
    Browser["Browser"]:::external
    Browser -->|Loads SPA| ReactSPA
    ReactSPA -->|uses| AuthContext
    AuthContext -->|attaches JWT| APIClient
    APIClient -->|calls| APIIndex
    APIClient -->|requests| DjangoREST
    ReactSPA -->|renders| UIComponents
    ReactSPA -->|navigates| Pages
    ReactSPA -->|uses| BrowserStorage
    ReactSPA -->|imports| AppEntry
    ReactSPA -->|bootstraps| MainEntry
    ReactSPA -.->|static assets| CDN

    DjangoREST -->|CRUD| Database
    DjangoREST -->|serves| SwaggerUI
    Browser -->|GET /docs/| SwaggerUI
    DjangoREST --o|generate PDF| PDFService
    DjangoREST --o|store assets| CDN

    %% Click Events - Frontend
    click ReactSPA "https://github.com/santoshvandari/accountingsystem/tree/main/frontend/"
    click AuthContext "https://github.com/santoshvandari/accountingsystem/blob/main/frontend/src/contexts/AuthContext.jsx"
    click APIClient "https://github.com/santoshvandari/accountingsystem/blob/main/frontend/src/api/base.js"
    click APIIndex "https://github.com/santoshvandari/accountingsystem/blob/main/frontend/src/api/index.js"
    click UIComponents "https://github.com/santoshvandari/accountingsystem/tree/main/frontend/src/components/"
    click Pages "https://github.com/santoshvandari/accountingsystem/tree/main/frontend/src/pages/"
    click ViteConfig "https://github.com/santoshvandari/accountingsystem/blob/main/frontend/vite.config.js"
    click EnvExample "https://github.com/santoshvandari/accountingsystem/blob/main/frontend/.env.example"
    click BrowserStorage "https://github.com/santoshvandari/accountingsystem/blob/main/frontend/src/helpers/browserStorage.js"
    click AppEntry "https://github.com/santoshvandari/accountingsystem/blob/main/frontend/src/App.jsx"
    click MainEntry "https://github.com/santoshvandari/accountingsystem/blob/main/frontend/src/main.jsx"

    %% Click Events - Backend
    click CoreSettings "https://github.com/santoshvandari/accountingsystem/blob/main/backend/core/settings.py"
    click CoreURLs "https://github.com/santoshvandari/accountingsystem/blob/main/backend/core/urls.py"
    click CorePermissions "https://github.com/santoshvandari/accountingsystem/blob/main/backend/core/permissions.py"
    click ASGI "https://github.com/santoshvandari/accountingsystem/blob/main/backend/core/asgi.py"
    click WSGI "https://github.com/santoshvandari/accountingsystem/blob/main/backend/core/wsgi.py"
    click AccountsModels "https://github.com/santoshvandari/accountingsystem/blob/main/backend/accounts/models.py"
    click AccountsManager "https://github.com/santoshvandari/accountingsystem/blob/main/backend/accounts/manager.py"
    click AccountsSerializers "https://github.com/santoshvandari/accountingsystem/blob/main/backend/accounts/serializers.py"
    click AccountsViews "https://github.com/santoshvandari/accountingsystem/blob/main/backend/accounts/views.py"
    click AccountsURLs "https://github.com/santoshvandari/accountingsystem/blob/main/backend/accounts/urls.py"
    click AccountsUtils "https://github.com/santoshvandari/accountingsystem/blob/main/backend/accounts/utils.py"
    click TransactionsModels "https://github.com/santoshvandari/accountingsystem/blob/main/backend/transactions/models.py"
    click TransactionsSerializer "https://github.com/santoshvandari/accountingsystem/blob/main/backend/transactions/serializer.py"
    click TransactionsViews "https://github.com/santoshvandari/accountingsystem/blob/main/backend/transactions/views.py"
    click TransactionsURLs "https://github.com/santoshvandari/accountingsystem/blob/main/backend/transactions/urls.py"
    click BillingModels "https://github.com/santoshvandari/accountingsystem/blob/main/backend/billing/models.py"
    click BillingSerializers "https://github.com/santoshvandari/accountingsystem/blob/main/backend/billing/serializers.py"
    click BillingViews "https://github.com/santoshvandari/accountingsystem/blob/main/backend/billing/views.py"
    click BillingURLs "https://github.com/santoshvandari/accountingsystem/blob/main/backend/billing/urls.py"

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#0066cc,color:#003366
    classDef backend fill:#d4edda,stroke:#228B22,color:#155724
    classDef database fill:#fff3cd,stroke:#e09e1e,color:#856404
    classDef external fill:#f0e6ff,stroke:#800080,color:#4b0082
```
