How sanskartakkamore/hackfest-dil works
Main Components
• Backend Service: Located under apps/backend, this component is built on NestJS. It includes several modules such as the core app module, configuration, feedback, and project modules. It also contains utility files (e.g., email.service.ts and jira.service.ts) that likely interact with external services like email systems and JIRA.
• Frontend Client: Found under apps/frontend, this is a Next.js application using the new App directory structure. It contains pages and features like a feedback form, and it reads data from JSON files and components from a shared UI package.
• Shared Packages: These include:
– packages/ui: A library of reusable UI components that the frontend uses (e.g., buttons, cards, nav elements).
– packages/eslint-config and packages/typescript-config: Tools that provide standardized configurations across the monorepo.
• DevOps/Monorepo Infrastructure: Turborepo-related files (turbo.json, .turbo folders) indicate that the project is managed as a monorepo, with built‑in support for caching, build orchestration, and dependency management.
Relationships and Interactions
• The Frontend communicates with the Backend via REST API calls to submit and retrieve feedback and project-related data.
• Within the Backend, different modules (feedback and project) encapsulate specific functionalities (e.g., schema definitions, controllers, and services), and they might share common configuration and utility modules.
• External integrations are represented by the utility services that manage emails and JIRA interactions.
• The shared UI package is consumed by the frontend to render consistent, reusable components.
• The monorepo’s configuration packages (ESLint, TypeScript) ensure consistency in development and build processes, but they are not part of the runtime system. Instead, they support developer productivity and code quality.
Architectural Patterns and Design Principles
• Separation of Concerns: Clearly divided responsibilities among frontend (user interface), backend (business logic and API orchestration) and shared libraries.
• Modularized Backend: Use of NestJS modules such as feedback and project that isolate different application domains.
• Reusable UI Components: A dedicated package for UI components emphasizes the DRY principle and reusability across the Next.js frontend.
• Monorepo Structure: Encourages consistency and simplifies dependency management and deployment using Turborepo.
Specific Elements
• Clear Labels: Each component must be labeled (e.g., “Frontend (Next.js)”; “Backend (NestJS)” with its internal modules like “Feedback Module” and “Project Module”; “Shared UI Components”; “Turborepo Monorepo”).