How nmchien1106/kanby-backend works
Kanby is a Trello-like REST API. The principal workflow is an authenticated user organizing workspaces into boards, lists, and cards, then enriching cards with checklists, labels, attachments, and comments. Activity events and notifications provide collaboration feedback; search and API documentation are additional capabilities. The tree and README establish the broader feature set, while sampled controllers confirm selected calls; unsampled subsystem wiring is shown only where documented, so uncertain links are omitted.
Main entry points: typeorm.config.ts PostgreSQL Data · auth.controller.ts Authentication · board.controller.ts Boards · card.controller.ts Cards
Components 21
Identity & Access
- Authentication
src/apis/auth/auth.controller.ts - User Profiles
src/apis/users/user.controller.ts - Roles & Permissions
src/apis/role/role.controller.ts
Project Organization
- Workspaces
src/apis/workspace/workspace.controller.ts - Boards
src/apis/board/board.controller.ts - Lists
src/apis/list/list.controller.ts - Cards
src/apis/card/card.controller.ts - Checklists
src/apis/checklist/checklist.controller.ts - Labels
src/apis/label/label.controller.ts - Global Search
src/apis/search/search.service.ts
Collaboration
- Comments
src/apis/comment/comment.controller.ts - Activity Log
src/apis/activity/activity.controller.ts - Event Bus
src/events/event-bus.ts - Notifications
src/apis/notification/notification.controller.ts - Live Notification Stream
src/apis/notification/SSE/notification-sse.service.ts
API Platform
- PostgreSQL Data
src/config/typeorm.config.ts - Redis
src/config/redis.config.ts - Cloudinary
src/config/cloundinary.ts - Email Delivery
src/config/email.config.ts - OpenAPI Docs
src/api-docs/openApiRouter.ts
Other components
- API Client
Connections 30
- API Client → Authentication: requests
- API Client → User Profiles: requests
- API Client → Workspaces: requests
- API Client → Boards: requests
- API Client → Lists: requests
- API Client → Cards: requests
- API Client → Checklists: requests
- API Client → Labels: requests
- API Client → Comments: requests
- API Client → Activity Log: requests
- API Client → Notifications: requests
- API Client → Global Search: requests
- API Client → OpenAPI Docs: views docs
- Authentication → Redis: stores tokens
- Authentication → Email Delivery: sends verification
- Authentication → User Profiles: registers users
- Workspaces → Redis: reads invites
- Boards → Redis: reads invites
- Boards → Event Bus: publishes events
- Cards → PostgreSQL Data: via service
- Lists → PostgreSQL Data: via service
- Labels → PostgreSQL Data: via service
- Checklists → PostgreSQL Data: via service
- Activity Log → PostgreSQL Data: reads activities
- Global Search → PostgreSQL Data: searches entities
- Notifications → Live Notification Stream: streams updates
- User Profiles → Cloudinary: uploads avatars
- Cards → Cloudinary: attachments
- Event Bus → Activity Log: logs events
- Event Bus → Notifications: notifies subscribers