How emanuel-amol/ndis-platform works
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