How fredericosferreira/kanban-flex works
Project type and purpose
• KanbanFlex is a full-stack, open-source web application for sprint retrospectives (“boards” + “cards” + votes).
• Frontend: Vue 3 SPA built with Vite.
• Backend: Node.js/Express REST API with MongoDB, containerized via Docker.
File structure
• Top-level “src”, “public”, “index.html” → Vue/Vite app.
• “backend/” → Node.js service (Dockerfile, docker-compose.yml, .env.sample).
• “backend/modules/{auth,boards}/controllers,routes” → MVC pattern.
• “backend/cloud/” → serverless function(s) (e.g., email notifications).
• docker-compose.yml spins up MongoDB for local dev.
• migrate-mongo config + migrations folder → database versioning.
• “templates/emails” + email.js → transactional email subsystem.
README
• Describes features (anonymous access, likes/dislikes, hide mode).
• Tech stack: Node.js, Vue, Typescript, MongoDB.
• Deployment hints: frontend on Netlify, backend via Docker.
• External services: SMTP/email provider, possibly cloud functions.
a. Main components:
• User’s Browser (SPA)
• CDN / Static Host (Netlify)
• API Gateway / Load Balancer (optional)
• Backend Service (Node.js/Express)
• MongoDB Database
• Email Service (SMTP or third-party)
• Cloud Function(s) (in backend/cloud)
b. Relationships & data flow:
1. Browser → CDN/Netlify → serves static assets (JavaScript/CSS).
2. SPA → HTTP(S) → Backend REST API.
3. Backend → MongoDB → data storage for boards, users, votes.
4. Backend → triggers Cloud Function → sends templated emails via SMTP.
5. Cloud Function → External Email Provider.
c. Architectural patterns & principles:
• MVC in backend: controllers, routes, services.
• Single Page Application front/back separation.
• Infrastructure as code: Docker Compose for local dev.
• Database migrations for schema/version management.
• Serverless for decoupled email tasks.
d. Key technologies:
• Frontend: Vue 3, Vite, TypeScript, Pinia (stores), Vue Router.
• Backend: Node.js, Express, migrate-mongo, dotenv.
• Database: MongoDB (Docker container or Atlas).
• CI/CD: Netlify for frontend, Docker build for backend.
• Email: email.js + HTML templates.
Detailed component breakdown
• SPA Layer:
• App.vue → core layout
• Components & Views → UI flows (BoardView, Auth)
• Stores (Pinia) → state management
• Utils/api.ts → HTTP client
• API Layer:
• index.js → server bootstrap
• modules/auth & modules/boards → feature modules
• utils.js → shared helpers
• Data Layer:
• Migrations → schema/indexes
• migrate-mongo-config → DB connection settings
• Infra:
• docker-compose.yml → local Mongo + API
• Dockerfile → backend container
• .env files → config