How rmit-nct/hub works
Main Components
• Monorepo (Turborepo): Show the overall organization with separate “apps” and “packages.”
• Web Application (apps/web): Represent it as a full‑stack Next.js app that includes both the frontend interface and backend API endpoints. Note that its file structure shows Next.js file-based routing (including extensive API routes under apps/web/src/app/api).
• Documentation Site (apps/docs): A Mintlify-powered documentation portal.
• Shared Libraries (under packages folder):
– UI components (packages/ui)
– TypeScript configurations (packages/typescript-config)
– ESLint configurations (packages/eslint-config)
– Transactional emails and related utilities (packages/transactional)
Relationships and Data Flows
• The Web Application (frontend) built with Next.js and Tailwind CSS renders the public user interface while internally using shared UI packages.
• It also consumes the API endpoints (organized under apps/web/src/app/api) for authentication, chat/AI interactions, workspace management, meeting planning (meet-together), and other business features.
• The shared packages are used by the web app and possibly other services. Indicate these as “libraries” that the Web App imports.
• The Docs App is mostly standalone but potentially references shared configurations or UI components if reuse is needed.
Important Architectural Patterns and Design Principles
• File‑based routing: Indicate that the Web App’s routing structure (pages and API endpoints) is defined by directory organization – a clear signal of the Next.js convention.
• CI/CD and Development Workflow: Optionally include external continuous integration/deployment mechanisms (e.g., GitHub workflows, pnpm scripts, Docker for Supabase) since the repo contains dedicated configurations (GitHub workflows in .github and pnpm, Turborepo, etc.).
• Shared configuration: Emphasize the use of packages (for UI, ESLint, TypeScript) as a way to enforce consistency and reusability across apps.
Relevant Technologies and Frameworks
• Next.js with React for the web application.
• Tailwind CSS (and Shadcn UI) for UI styling.
• Supabase as the backend database and real‑time service.
• Turborepo for monorepo management.
• PNPM for dependency management.
• Docker for running the local Supabase instance.
• GitHub Actions as visible in the .github/workflows folder for testing, code analysis, and deployment pipelines.
b. Under “Apps,” branch into “Web Application (apps/web)” and “Documentation Site (apps/docs).”
– Frontend UI (Next.js pages, components, Tailwind, Shadcn UI)
– Backend/API layer (Next.js API routes, organized under apps/web/src/app/api)
g. External dependencies (e.g., Node.js, Vercel [if used for deployment]) for context.
Happy diagramming!