How nitasheu/mindory works
Project Type and Purpose
• Mindory is a full-stack web application.
• The frontend is built with Vue.js 3 (using the Composition API, Vite, and Tailwind CSS) and focuses on interactive UI (components, pages, modules, and state management via Pinia).
• The backend is implemented in NestJS, following a module-based architecture which organizes business logic into feature-specific modules (e.g., auth, code-processing, repositories, user) and includes common utilities (custom decorators, filters, pipes, and services).
• The project leverages Supabase for data storage as well as real-time features, evident from the dedicated supabase/migrations folder.
Major Architectural Components
a. Frontend Application:
• Contains directories for components, modules (auth, dashboard, profile, repositories, etc.), pages, router, and store.
• Uses Vue Router for navigation and Pinia for state management.
• Responsibilities include rendering the interactive visualization of codebases, handling user interactions, authentication, and making API requests to the backend.
b. Backend Application:
• Built with NestJS and divided into several modules (e.g., authentication, code-processing, repositories, user).
• Includes common shared modules (custom decorators, guards, filters, interceptors, pipes) and configuration modules (for connecting to Supabase, Neo4j, and other services).
• Manages API endpoints, business logic, authentication (using custom JWT guards, DTO validations), and integrates with external services like Supabase for real-time data operations.
• Swagger is used for API documentation, making the backend contract clear for frontend integration.
c. Database Layer:
• Uses Supabase as the primary database provider with SQL migrations maintained under supabase/migrations.
• The backend includes database-specific modules and services that directly interact with these data stores.
Relationships and Interactions
• Showing intra-backend interactions, such as how common modules (e.g., DTOs, custom decorators) support multiple feature modules.
• Optionally, include the API Documentation service (Swagger) as a component that sits adjacent to the backend to indicate clear endpoint contracts.
Highlighting Architectural Patterns and Technologies
• For the Frontend:
• Module-based architecture, state management, lazy-loaded routes, and the use of the Composition API.
• That components, views, and state modules interact to render a responsive UI.
• For the Backend:
• NestJS’s module-based architecture, dependency injection, and use of decorators for routing and authentication.
• Detail the segregation of concerns: controllers handle routing, services encapsulate business logic, and modules group related functionality.
• Use of DTOs for validation and Swagger for API docs.
• For the Database:
• That Supabase is used for both storage and real-time functionalities, together with SQL migration scripts to manage data schema changes.