How davidgg00/trelloclone works
Project Type and Purpose
• This is a full-stack application designed to clone Trello’s functionality. It supports boards, lists, tasks, user management, and board permissions – features typically seen in project management and task tracking applications.
• The backend is built using NestJS with clearly defined modules (boards, lists, tasks, users, board-permission, auth, etc.) while the frontend appears to use a modern framework (Vue.js, as evidenced by .vue files) along with Vite as the build tool.
Key Architectural Components
a. Frontend:
• Located under the “front” directory.
• Contains essential files such as App.vue, main.ts, and routing and state management configurations.
• Handles the user interface with components (e.g., BoardList.vue, List.vue, Task.vue) and manages client-side routing and API calls (using Axios configured in the “api” subdirectory).
• Dockerfile and Docker/Nginx configurations hint at containerized deployment and static file serving.
b. Backend:
• Found under the “back” directory, using NestJS.
• Pattern organized by modules representing domain features: boards, lists, tasks, users, board-permission, and auth.
• Includes controllers, services, and DTOs for various functionalities, demonstrating separation of concerns.
• An events gateway is also present for real-time features (likely using websockets), as indicated by the “events” directory.
• Testing is integrated through spec files for controllers and services.
• The existence of Dockerfile and configuration files (.env.copy, tsconfig, etc.) suggests a containerized and type-safe Node.js server.
c. Database & Persistence (Implicit):
• Although no explicit database configuration files are seen, the entity files (e.g., board.entity.ts, list.entity.ts) imply use of an ORM for database interactions.
d. External Services/Deployment & CI/CD:
• GitHub workflows (in .github) point to automatic deployments.
• docker-compose.yml is used to orchestrate containerized services (including likely front-end, back-end, and possibly database containers).
Diagramming the Interactions
• Frontend Application: Mark as “Frontend – Vue.js & Vite” with subcomponents like “UI Components”, “Router”, “Store”, and “API module”.
• Backend Application: Mark as “Backend – NestJS” showing modules for Boards, Lists, Tasks, Users, Auth, Board-Permissions, and Events (Websocket Gateway). Indicate inclusion of testing and middleware/authentication (e.g., JWT in users/jwt-auth).
• External Integration: Optionally add “GitHub Actions” for CI/CD, and “Docker” environment (via docker-compose) elements showing container orchestration.
• API calls from the Frontend to the Backend (HTTP requests).
• Data flow from the Backend to the Database.
• Real-time communications between the Frontend and the Events (WebSocket Gateway on the backend).
Architectural Patterns/Principles to Highlight
• Modularity: Each domain (boards, lists, tasks, etc.) is organized into its own module with controllers, services, DTOs, and entity definitions (Backend side).
• Separation of Concerns: Clear division between UI (Frontend) and business logic (Backend).
• Containerization: Both the frontend and backend have Docker setups, suggesting they are deployed in separate containers.
• Real-Time Communication: The events module is built using a gateway for websockets.
• Testing/Quality Assurance: Presence of extensive test files indicates a strong testing culture.
Additional Detail
• For the frontend, indicate key modules doing API communication and UI state management.