{"id":31698839,"url":"https://github.com/smruthik24/kanban-app","last_synced_at":"2026-04-11T01:19:12.730Z","repository":{"id":318113894,"uuid":"1070038968","full_name":"smruthik24/kanban-app","owner":"smruthik24","description":"A simplified Trello-like Kanban application built with full-stack web technologies to demonstrate HLD, LLD, and real-time full-stack development capabilities. This project enables users to create workspaces, boards, lists, and cards, collaborate in real-time (via WebSockets), and manage tasks, comments, and activity logs efficiently.","archived":false,"fork":false,"pushed_at":"2025-10-05T06:59:15.000Z","size":4406,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-05T08:22:05.138Z","etag":null,"topics":["expressjs","fastapi","mongodb","nodejs","reactjs","swagger-ui"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smruthik24.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-05T06:09:19.000Z","updated_at":"2025-10-05T07:00:41.000Z","dependencies_parsed_at":"2025-10-05T08:32:12.014Z","dependency_job_id":null,"html_url":"https://github.com/smruthik24/kanban-app","commit_stats":null,"previous_names":["smruthik24/kanban-app"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/smruthik24/kanban-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smruthik24%2Fkanban-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smruthik24%2Fkanban-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smruthik24%2Fkanban-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smruthik24%2Fkanban-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smruthik24","download_url":"https://codeload.github.com/smruthik24/kanban-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smruthik24%2Fkanban-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000701,"owners_count":26082805,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["expressjs","fastapi","mongodb","nodejs","reactjs","swagger-ui"],"created_at":"2025-10-08T19:11:10.230Z","updated_at":"2025-10-08T19:11:32.718Z","avatar_url":"https://github.com/smruthik24.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🗂️ Kanban Board – Trello-like Real-Time Collaboration App\n\nA simplified **Trello-like Kanban application** built with full-stack web technologies to demonstrate HLD, LLD, and real-time full-stack development capabilities.  \nThis project enables users to create **workspaces, boards, lists, and cards**, collaborate in **real-time** (via WebSockets), and manage **tasks, comments, and activity logs** efficiently.\n\n---\n\n## ⚙️ Tech Stack \u0026 Rationale\n\n### **Backend**\n- **Node.js + Express.js**: Lightweight, scalable, and perfect for REST APIs with async I/O.\n- **MongoDB (Mongoose)**: Flexible NoSQL database for nested structures like boards, lists, and cards.\n- **JWT Authentication**: Secure token-based auth for stateless API sessions.\n- **Socket.IO**: Real-time collaboration for card movements and live comments.\n- **bcrypt**: For password hashing and user authentication security.\n\n### **Frontend**\n- **React.js (Vite/CRA)**: Modular UI components for a responsive and interactive Kanban board.\n- **React DnD / react-beautiful-dnd**: Enables drag-and-drop list and card reordering.\n- **Axios + React Query**: Efficient API communication with caching.\n- **Tailwind CSS**: Rapid UI styling and responsive design.\n\nThe combination ensures a **scalable, maintainable, and real-time interactive** system with minimal latency and high UX responsiveness.\n\n---\n\n## 🚀 Setup \u0026 Run Instructions\n\n### 🧩 Prerequisites\n- Node.js v18+\n- MongoDB (local or Atlas)\n- npm / yarn\n\n---\n\n### 🗄 Backend Setup\n\n```bash\ncd backend\nnpm install\n```\n### Create a .env file in the backend/ directory (see .env.example below).\nThen run the backend server:\n\n```bash\nnpm run dev\n```\n\n\nTo seed demo data:\n\n```bash\nnode scripts/seed.js\n```\n\n\nThis will populate demo users, workspace, board, lists, and cards.\n\n🎨 Frontend Setup\n``` bash\ncd frontend\nnpm install\nnpm run dev\n```\n\n\n### Access the app at:\n👉 http://localhost:3000\n\n### 🧠 Environment Variables Sample\n\nCreate a file named .env (or .env.example for reference):\n\n### MongoDB Connection\nMONGODB_URI=mongodb://127.0.0.1:27017/kanban_app\n\n### JWT Secret\nJWT_SECRET=your_jwt_secret_key\n\n### Database name\nDB_NAME=test_database\n\n### CORS ORIGIN\nCORS_ORIGINS=http://localhost:3000\n\n## 🧱 Database Schema Overview\n### 🧩 Entity Relationship Diagram (ERD)\n\n### 📘 Key Collections\n| **Collection** | **Description** |\n|----------------|-----------------|\n| **Users** | Registered users with name, email, avatar, and hashed password. |\n| **Workspaces** | Organizational groups containing multiple boards. |\n| **Boards** | Contain lists, members, and visibility settings. |\n| **Lists** | Columns in a board (Backlog, In Progress, Done, etc.). |\n| **Cards** | Tasks within lists, can be moved, labeled, and assigned. |\n| **Comments** | User discussions attached to cards. |\n| **Activity** | Audit logs of actions (card created, moved, commented). |\n\n\n\n\n### 🧩 Example Document (Cards Collection)\n{\n  \"title\": \"Build Login Page\",\n  \"description\": \"Implement JWT authentication and UI for login/signup.\",\n  \"labels\": [\"frontend\", \"auth\"],\n  \"assignees\": [\"user123\"],\n  \"dueDate\": \"2025-10-15\",\n  \"position\": 1024,\n  \"listId\": \"list_001\"\n}\n\n\n\n### 🔄 Real-Time Server Setup\n\nReal-time events are powered by Socket.IO.\n\n\n\n### 🔌 Real-time Events\nEvent\tDescription\ncardMoved\tBroadcasts when a card is moved between lists.\ncommentAdded\tSends a live update when a new comment is added.\nboardUpdated\tNotifies connected clients of board updates.\n\n\n## 📂 Project Structure\n\n```plaintext\n📁 kanban-app/\n├── 📁 backend/\n│   ├── src/\n│   ├── package.json\n│   ├── .env.example\n│   \n│\n├── 📁 frontend/\n│   ├── src/\n│   ├── public/\n│   ├── package.json\n│   ├── components.json\n│   ├── package.json\n│ \n│\n├── 📁 docs/\n│   ├── HLD.md\n│   ├── LLD.md\n│   ├── architecture-diagram.png\n│   ├── erd.png\n│   └── api-reference.yaml (Swagger)\n│\n├── 📁 scripts/\n│   └── seed.js\n│\n├── README.md\n└── 📁 demo-screenshots/\n    ├── Activity.png\n    ├── Card.png\n    ├── Dashboard.png\n    ├── Newboard.png\n    ├── Register.png\n    ├── Workspace.png\n    └── labels.png\n\n```\n\n\n### 🧪 API Testing\n\nUse Postman or curl to test API endpoints.\n\nExample:\n``` bash\ncurl -X POST http://localhost:5000/api/auth/login \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"email\":\"demo@example.com\", \"password\":\"123456\"}'\n```\n\n\n\n### 📸 Demo Screenshots\nFeature\tScreenshot\n\u003cimg width=\"1920\" height=\"1080\" alt=\"Register\" src=\"https://github.com/user-attachments/assets/c1aa1dbd-0539-4cc2-8331-31e9ea4ee6cd\" /\u003e\n\nBoard View\n\n\u003cimg width=\"1920\" height=\"1080\" alt=\"Dashboard\" src=\"https://github.com/user-attachments/assets/d3b1936b-1463-424b-9902-534ec64a49fd\" /\u003e\n\nCard Modal\n\n\u003cimg width=\"1920\" height=\"1080\" alt=\"Card\" src=\"https://github.com/user-attachments/assets/d9b2a269-cdc4-4397-93c7-54d663c1342d\" /\u003e\n\nWorkspace\n\n\u003cimg width=\"1920\" height=\"1080\" alt=\"Workspace\" src=\"https://github.com/user-attachments/assets/053da6d1-a26c-4a16-b070-091a8fba20ac\" /\u003e\n\nReal-time comments\n\n\u003cimg width=\"1920\" height=\"1080\" alt=\"labels\" src=\"https://github.com/user-attachments/assets/207597af-e1ed-4aa1-9a69-07d09a0bf531\" /\u003e\n\n\n\n\n\n### ⚖️ Known Limitations\n\nOffline sync not yet supported (planned feature).\n\nOnly two roles supported (owner/member).\n\nActivity log limited to 20 most recent events.\n\nSearch limited to card title, label, or assignee.\n\n###  Next Steps\n\nAdd CRDTs or server-side conflict resolution for real-time consistency.\n\nExpand role-based access control.\n\nAdd Calendar View and analytics dashboards.\n\nIntegrate email notifications for mentions.\n\nImplement offline-first support.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmruthik24%2Fkanban-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmruthik24%2Fkanban-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmruthik24%2Fkanban-app/lists"}