Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 2.62 KB

File metadata and controls

27 lines (22 loc) · 2.62 KB

TaskFlow Documentation

TaskFlow is a full-stack monorepo productivity platform built with Next.js and Express. The codebase follows Clean Architecture, with clear separation between use cases, repositories, interfaces, DTOs, validation, and infrastructure (ORM, auth, event bus). This documentation describes the structure and how the pieces fit together.

How to use these docs

  1. Start with Architecture for the big picture and layers.
  2. Read Data flow to see a concrete request path (e.g. create user).
  3. Use Monorepo to find where everything lives (packages, paths, scripts).
  4. Dive into package docs for details: Core, Infra, Shared.
  5. See Backend stack for routes, controllers, and middlewares.
  6. Check Design patterns for SOLID and Clean Code mapping.
  7. See SOLID and Clean Architecture for principle-by-principle examples from the codebase.

Documentation index

Document Description
Architecture High-level architecture, layers, dependency rule, request path
Data flow End-to-end flow: HTTP → validation → use case → DB and events
Monorepo Workspaces, packages, build order, key paths, scripts
Backend stack API app: routes, controllers, middlewares, config
Core package Use cases, subscribers, and how they use ports
Infra package Repositories, interfaces, Prisma, event bus, errors
Shared package DTOs, Zod schemas, entities, events, shared types
Design patterns Repository, use case, DI, adapters, SOLID, Clean Code
SOLID and Clean Architecture How SOLID and Clean Architecture are applied, with workspace code examples