# emanuel-amol/ndis-platform architecture

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

- Interactive diagram: https://gitdiagram.com/emanuel-amol/ndis-platform
- Repository: https://github.com/emanuel-amol/ndis-platform

## Overview

##### Project Type & Purpose
- This is a multi‐module full-stack scaffold for an AI-Integrated NDIS Provider Management Platform.
- It provides six independent React-Vite frontends (visual only) and accompanying FastAPI backend skeletons, all orchestrated by a single dev runner and reverse proxy.

##### File Structure Analysis
- Root
- dev.mjs – orchestrates module installs, starts Vite dev servers, and spins up a reverse proxy on :8080
- package.json – runner dependencies (http-proxy, open)
- Per-Module (portal, talent-acquisition, onboarding, rostering-sil, compliance-billing, ticketing-incidents)
- index.html, vite.config.js – config for React+Vite dev server and base path
- src/ – React application (main.jsx, App.jsx, styles.css, plus a Nav.jsx in portal)
- backend/ – FastAPI skeleton (app.py, requirements.txt, routers/, services/)

##### README Insights
- Single command (`npm start`) boots all frontends behind a reverse proxy at localhost:8080
- Each module’s dev server runs on its own port and base path (/, /talent/, /onboarding/, etc.)
- Each backend is meant to run independently on ports 7000–7005 with a `/health` endpoint
- Future enhancements: API gateway, real routers/services, Dockerization

a. Main Components
- Dev Runner & Reverse Proxy (Node script on port 8080)
- Frontend Modules (6 separate React-Vite apps)
- Backend Modules (6 FastAPI apps)
- API Contracts (docs/api-contracts.md)
- External/Future Services (e.g., Xero invoicing, Watsonx AI, RPA engines)
b. Component Relationships & Data Flows
1. Browser → Reverse Proxy (:8080)
2. Reverse Proxy routes `/`, `/talent/`, `/onboarding/`, etc. to respective Vite dev servers
3. Frontends make REST calls directly to their paired FastAPI backend (ports 7000–7005)
4. Backends expose `/health` plus future business endpoints documented in API contracts
5. Future: backends integrate with databases, external AI services (Watsonx), Xero, RPA/ID providers
c. Architectural Patterns & Principles
- Micro-frontend style: each module is standalone, co-located front/backend
- Separation of concerns: UI (React) vs. API (FastAPI)
- Single entry-point dev proxy for uniform routing
- Clear module ownership and scope (per README table)
d. Key Technologies
- Frontend: React, Vite, Node.js
- Backend: Python, FastAPI, Uvicorn
- Dev Orchestration: dev.mjs, http-proxy

## Diagram (Mermaid)

```mermaid
flowchart TD
    direction TB

    %% Client Tier
    Browser["Browser"]:::client
    Proxy["Dev Runner & Reverse Proxy (Node.js:8080)"]:::runner
    Browser -->|HTTP| Proxy

    %% Frontend Modules
    subgraph "Frontend Modules"
        direction TB
        PortalFE["Portal Frontend (React+Vite – :5100, base /)"]:::frontend
        TalentFE["Talent Acquisition Frontend (React+Vite – :5101, base /talent/)"]:::frontend
        OnboardingFE["Onboarding Frontend (React+Vite – :5102, base /onboarding/)"]:::frontend
        RosteringFE["Rostering-SIL Frontend (React+Vite – :5103, base /rostering-sil/)"]:::frontend
        ComplianceFE["Compliance-Billing Frontend (React+Vite – :5104, base /compliance-billing/)"]:::frontend
        TicketingFE["Ticketing-Incidents Frontend (React+Vite – :5105, base /ticketing-incidents/)"]:::frontend
    end

    %% Proxy routing to frontends
    Proxy -->|"/"| PortalFE
    Proxy -->|"/talent/"| TalentFE
    Proxy -->|"/onboarding/"| OnboardingFE
    Proxy -->|"/rostering-sil/"| RosteringFE
    Proxy -->|"/compliance-billing/"| ComplianceFE
    Proxy -->|"/ticketing-incidents/"| TicketingFE

    %% API Tier
    subgraph "API Tier"
        direction TB
        PortalBE["Portal Backend (FastAPI – port 7000)"]:::backend
        TalentBE["Talent Acquisition Backend (FastAPI – port 7001)"]:::backend
        OnboardingBE["Onboarding Backend (FastAPI – port 7002)"]:::backend
        RosteringBE["Rostering-SIL Backend (FastAPI – port 7003)"]:::backend
        ComplianceBE["Compliance-Billing Backend (FastAPI – port 7004)"]:::backend
        TicketingBE["Ticketing-Incidents Backend (FastAPI – port 7005)"]:::backend
    end

    %% Frontend to Backend flows
    PortalFE -->|"REST calls"| PortalBE
    TalentFE -->|"REST calls"| TalentBE
    OnboardingFE -->|"REST calls"| OnboardingBE
    RosteringFE -->|"REST calls"| RosteringBE
    ComplianceFE -->|"REST calls"| ComplianceBE
    TicketingFE -->|"REST calls"| TicketingBE

    %% Documentation
    Docs["API Contracts (docs/api-contracts.md)"]:::docs

    %% Future Integrations
    subgraph "Future Integrations" style future
        direction TB
        Database["Database"]:::db
        Watsonx["Watsonx AI Service"]:::future
        Xero["Xero Invoicing API"]:::future
        RPA["RPA Engine"]:::future
    end

    %% Backend to Future
    PortalBE -.->|future integration| Database
    PortalBE -.->|future integration| Watsonx
    TalentBE -.->|future integration| Xero
    OnboardingBE -.->|future integration| RPA

    %% Click Events
    click Proxy "https://github.com/emanuel-amol/ndis-platform/blob/main/dev.mjs"
    click Proxy "https://github.com/emanuel-amol/ndis-platform/blob/main/package.json"
    click Docs "https://github.com/emanuel-amol/ndis-platform/blob/main/docs/api-contracts.md"
    click PortalFE "https://github.com/emanuel-amol/ndis-platform/blob/main/portal/index.html"
    click PortalFE "https://github.com/emanuel-amol/ndis-platform/blob/main/portal/vite.config.js"
    click PortalFE "https://github.com/emanuel-amol/ndis-platform/tree/main/portal/src/"
    click PortalBE "https://github.com/emanuel-amol/ndis-platform/blob/main/portal/backend/app.py"
    click PortalBE "https://github.com/emanuel-amol/ndis-platform/blob/main/portal/backend/requirements.txt"
    click TalentFE "https://github.com/emanuel-amol/ndis-platform/blob/main/talent-acquisition/index.html"
    click TalentFE "https://github.com/emanuel-amol/ndis-platform/blob/main/talent-acquisition/vite.config.js"
    click TalentFE "https://github.com/emanuel-amol/ndis-platform/tree/main/talent-acquisition/src/"
    click TalentBE "https://github.com/emanuel-amol/ndis-platform/blob/main/talent-acquisition/backend/app.py"
    click TalentBE "https://github.com/emanuel-amol/ndis-platform/blob/main/talent-acquisition/backend/requirements.txt"
    click OnboardingFE "https://github.com/emanuel-amol/ndis-platform/blob/main/onboarding/index.html"
    click OnboardingFE "https://github.com/emanuel-amol/ndis-platform/blob/main/onboarding/vite.config.js"
    click OnboardingFE "https://github.com/emanuel-amol/ndis-platform/tree/main/onboarding/src/"
    click OnboardingBE "https://github.com/emanuel-amol/ndis-platform/blob/main/onboarding/backend/app.py"
    click OnboardingBE "https://github.com/emanuel-amol/ndis-platform/blob/main/onboarding/backend/requirements.txt"
    click RosteringFE "https://github.com/emanuel-amol/ndis-platform/blob/main/rostering-sil/index.html"
    click RosteringFE "https://github.com/emanuel-amol/ndis-platform/blob/main/rostering-sil/vite.config.js"
    click RosteringFE "https://github.com/emanuel-amol/ndis-platform/tree/main/rostering-sil/src/"
    click RosteringBE "https://github.com/emanuel-amol/ndis-platform/blob/main/rostering-sil/backend/app.py"
    click RosteringBE "https://github.com/emanuel-amol/ndis-platform/blob/main/rostering-sil/backend/requirements.txt"
    click ComplianceFE "https://github.com/emanuel-amol/ndis-platform/blob/main/compliance-billing/index.html"
    click ComplianceFE "https://github.com/emanuel-amol/ndis-platform/blob/main/compliance-billing/vite.config.js"
    click ComplianceFE "https://github.com/emanuel-amol/ndis-platform/tree/main/compliance-billing/src/"
    click ComplianceBE "https://github.com/emanuel-amol/ndis-platform/blob/main/compliance-billing/backend/app.py"
    click ComplianceBE "https://github.com/emanuel-amol/ndis-platform/blob/main/compliance-billing/backend/requirements.txt"
    click TicketingFE "https://github.com/emanuel-amol/ndis-platform/blob/main/ticketing-incidents/index.html"
    click TicketingFE "https://github.com/emanuel-amol/ndis-platform/blob/main/ticketing-incidents/vite.config.js"
    click TicketingFE "https://github.com/emanuel-amol/ndis-platform/tree/main/ticketing-incidents/src/"

    %% Styles
    classDef frontend fill:#DDEEFF,stroke:#0066CC
    classDef backend fill:#EEFFDD,stroke:#009900
    classDef runner fill:#EEEEEE,stroke:#666666
    classDef client fill:#F0F0F0,stroke:#999999
    classDef docs fill:#FFF2CC,stroke:#CC9900
    classDef future fill:#F9F9F9,stroke-dasharray: 5 5
    classDef db fill:#FFE0E0,stroke:#CC0000

    class Browser client
    class Proxy runner
    class Docs docs
    class Database db
    class Watsonx,Xero,RPA future
```
