How icebob/kantab works
This project is a full-stack application implementing a Kanban board system that uses a microservices architecture powered by Moleculer on the backend and Vue.js on the frontend. The overall design integrates multiple backend services (handling accounts, boards, cards, lists, activities, etc.), a dedicated frontend client, and an extensive infrastructure for testing, monitoring, and deployment.
Main Components
• Frontend Application:
• Located in the "frontend" folder.
• Built with Vue.js (using VueX, Vue Router, and tailored components like Board.vue, Card.vue, etc.).
• Responsible for rendering the Kanban board, handling authentication, and communicating with backend endpoints (e.g., GraphQL and REST).
• Backend Microservices:
• Implemented in the "backend" folder using Moleculer.
• Contains services (accounts.service.js, activities.service.js, boards.service.js, cards.service.js, lists.service.js, etc.) that handle specific business functionality.
• Uses middleware (e.g., for authentication, permissions, GraphQL/OpenAPI endpoints generation) and mixins, which help extend core functionalities such as database access (MongoDB), authentication strategies, and caching.
• Exposes multiple interfaces such as a global REST API, GraphQL endpoint (with its playground at /graphql), and OpenAPI/Swagger UI (at /openapi).
• Data Storage:
• The project uses MongoDB (as referenced in the README regarding the MongoDB connection). This acts as the primary data store for application state.
• Monitoring and Metrics:
• There is a dedicated "monitoring" folder.
• Utilizes Prometheus and Grafana. Multiple deployment descriptors for monitoring (e.g., Grafana plugins and Prometheus configurations) indicate that key metrics (and alerts) from the microservices are captured and visualized.
• Deployment & Infrastructure:
• Docker-related files (Dockerfile, docker-compose.*.yml) are provided to containerize the application.
• Kubernetes configuration files (in the "kubernetes" folder) are present to facilitate cloud deployments.
• A Moleculer configuration is also included (moleculer.config.js) to orchestrate the distributed microservices.
• Testing Infrastructure:
• There are extensive tests: backend unit tests, integration tests (in backend/tests) and E2E tests (in tests/e2e), reflecting a solid continuous integration pipeline.
• CI/CD workflows are defined under the .github worklow folder.
Important Architectural Patterns and Technologies to Highlight
• Microservices Architecture: Emphasize that the backend is decoupled into multiple services that can be independently deployed.
• Service Communication: Note Moleculer’s built-in message-based RPC mechanism.
• API Layer: Show the dual interface – both REST (global REST API, Swagger/OpenAPI) and GraphQL interfaces.
• Frontend MVVM Pattern: The Vue.js application relies on VueX for state management and Vue Router for navigation.
• Testing and Continuous Integration: Indicate that testing is robust, with unit, integration, and end-to-end tests ensuring quality.