How phanng0605/linkedintu works
Main Components
• Web Frontend: Built using Next.js (React) located in apps/web-frontend. It contains pages, components, UI libraries, and static assets.
• Node API (Optional): An Express (or similar) backend found under apps/node-api that provides additional API functionality if needed.
• AI API: A FastAPI service under apps/ai-api dedicated to AI/ML functions, training pipelines, resume analysis, and related data processing. It encapsulates the AI logic, including modules for data augmentation, model fine-tuning, and text parsing.
• Shared Packages: Although the file tree provided does not explicitly show them, the README indicates that shared utilities (shared-utils) and shared UI components (shared-ui) exist to be used by both frontend and other services.
• Supporting Elements: This category includes CI/CD and deployment scripts (scripts folder) and documentation (docs folder).
Relationships and Interactions
• The Web Frontend interacts with the backends via API calls:
– It communicates directly with the AI API (FastAPI) for machine learning functionalities.
– It may call the Node API (if deployed) for additional non-AI REST endpoints.
• Shared packages are referenced as libraries in the Web Frontend and potentially within the APIs, ensuring consistency across the codebase.
• The services themselves (Next.js, Node/Express, and FastAPI) run independently but are linked together using a workspace manager (like Yarn or PNPM) based on the monorepo structure.
• CI/CD scripts and configuration files manage building, testing, and deployment across these components.
Architectural Patterns and Design Principles
• Modularity: The monorepo is structured to keep applications independent (each in its own app folder) and promotes code reuse through shared packages.
• Separation of Concerns: Each service handles its own domain (frontend UI, backend API logic, AI/ML processing).
• Microservices-like Elements: Even though this is a monorepo, the different services (Next.js, Node, and FastAPI) operate like loosely coupled services.
• Clear Service Boundaries: Data flows among these services via defined API endpoints, making the separation clear.
Relevant Technologies and Frameworks
• Next.js (React) – for the frontend.
• Node.js/Express (optional) – for additional backend API services.
• FastAPI (Python) – powering AI/ML endpoints, training pipelines, and data processing.
• Additional tools: Uvicorn (ASGI server for FastAPI), Yarn/PNPM for dependency management, and shared packages in JavaScript/TypeScript for utility functions and UI.