# rohit8bitcoder/devdesk architecture

> Architecture diagram of the GitHub repository rohit8bitcoder/devdesk, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rohit8bitcoder/devdesk
- Repository: https://github.com/rohit8bitcoder/devdesk

## Overview

##### Project type and purpose
- DevDesk is an open-source, developer-focused ticketing and DevOps automation tool.
- The repo contains only a “backend” directory, so it’s a RESTful API service (no bundled UI here).

##### File structure
- Top-level: README.md, .gitignore, and a single “backend” folder.
- “backend” contains:
- build.js, tsconfig.json, package.json → build and TypeScript config
- src/server.ts → application entry point
- src/routes → Express routers by resource (auth, profile, projects, tickets, comments, activities)
- src/services → business-logic layer (e.g. ticketService interacts with Supabase client)
- src/config → external-service clients (supabaseClient.ts)
- src/middleware → cross-cutting concerns (authentication, validation, error handling)
- src/validators & src/zod → request schema definitions and zod-powered validation
- src/utils → helper functions (asyncHandler wrapper, sendResponse)
- src/types → TypeScript request/ticket type definitions

##### Key insights from README
- Focus is on ticketing and DevOps automation
- Backend is the core; clients (CLI, third-party UI) will consume the API

##### Main components
a. Client(s):
- Developer UI or CLI that sends HTTP/HTTPS requests
b. API Gateway (Express server):
- server.ts boots Express app, mounts middleware, routers
c. Middleware layer:
- validateRequest (zod), AuthMiddleware (JWT/session), validateTicket, errorHandler
d. Routing layer:
- authRouter, profileRouter, projectsRouter, ticketsRouter, ticketCommentsRouter, ticketActivityRouter
e. Controller layer:
- authController, profileController, projectController, ticketController, ticketCommentController, ticketActivityController
f. Service layer:
- ticketService (and other domain services) encapsulate business logic
g. Data layer:
- supabaseClient (in config) connecting to Supabase database
h. Utilities:
- asyncHandler, sendResponse
i. External dependencies:
- Supabase (PostgreSQL), zod (validation), Express, any auth libraries

##### Relationships and interactions
1. Client → Express server (HTTP request)
2. Request → global middleware (CORS, JSON parser)
3. → validateRequest/zod → AuthMiddleware → specific validateTicket
4. → appropriate Router (e.g. ticketsRouter)
5. → Controller method
6. → Calls Service method
7. → Service uses supabaseClient to query/update DB
8. → Service returns data
9. → Controller calls sendResponse → HTTP response to Client
10. Errors bubble up to errorHandler middleware

##### Architectural patterns and design principles
- Layered architecture (routing → controllers → services → data)
- Separation of concerns (validation, auth, error handling)
- Dependency inversion: controllers depend on services; services depend on a client abstraction
- Validation powered by zod for strong request schemas
- Async wrappers to centralize error catching

- Clear component names (e.g. “ticketController”)
- Rectangles for code modules
- Annotations for key technologies (Express, Supabase, zod)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    Client["Client (CLI / UI)"]:::external

    %% API Gateway
    Server["API Gateway\n(Express Server)"]:::gateway

    %% Middleware Layer
    validateRequest["validateRequest"]:::middleware
    authMW["AuthMiddleware"]:::middleware
    validateTicket["validateTicket"]:::middleware
    errorHandler["errorHandler"]:::middleware

    %% Validation Schemas
    zodValidators["Zod Schemas\n(src/validators)"]:::external
    zodUtils["Zod Utilities\n(src/zod)"]:::external

    %% Routing Layer
    subgraph "Routing Layer"
        authRouter["authRouter"]:::router
        profileRouter["profileRouter"]:::router
        projectsRouter["projectsRouter"]:::router
        ticketsRouter["ticketsRouter"]:::router
        ticketCommentsRouter["ticketCommentsRouter"]:::router
        ticketActivityRouter["ticketActivityRouter"]:::router
    end

    %% Controller Layer
    subgraph "Controller Layer"
        authController["authController"]:::controller
        profileController["profileController"]:::controller
        projectController["projectController"]:::controller
        ticketController["ticketController"]:::controller
        ticketCommentController["ticketCommentController"]:::controller
        ticketActivityController["ticketActivityController"]:::controller
    end

    %% Service Layer
    ticketService["ticketService"]:::service

    %% Data Layer
    supabaseClient["Supabase Client"]:::db

    %% Utilities
    asyncHandler["asyncHandler"]:::util
    sendResponse["sendResponse"]:::util

    %% Request Flow
    Client -->|"HTTP JSON"| Server
    Server --> validateRequest
    validateRequest --> authMW
    authMW --> validateTicket
    validateTicket --> authRouter
    validateTicket --> profileRouter
    validateTicket --> projectsRouter
    validateTicket --> ticketsRouter
    validateTicket --> ticketCommentsRouter
    validateTicket --> ticketActivityRouter

    %% Validation usage
    validateRequest -->|uses| zodValidators
    validateTicket -->|uses| zodUtils

    %% Routing to Controllers
    authRouter --> authController
    profileRouter --> profileController
    projectsRouter --> projectController
    ticketsRouter --> ticketController
    ticketCommentsRouter --> ticketCommentController
    ticketActivityRouter --> ticketActivityController

    %% Controllers to Services
    authController --> ticketService
    profileController --> ticketService
    projectController --> ticketService
    ticketController --> ticketService
    ticketCommentController --> ticketService
    ticketActivityController --> ticketService

    %% Services to Data Layer
    ticketService -->|SQL queries| supabaseClient
    supabaseClient -->|data| ticketService

    %% Response Flow
    ticketService --> authController
    ticketService --> profileController
    ticketService --> projectController
    ticketService --> ticketController
    ticketService --> ticketCommentController
    ticketService --> ticketActivityController

    authController --> asyncHandler
    profileController --> asyncHandler
    projectController --> asyncHandler
    ticketController --> asyncHandler
    ticketCommentController --> asyncHandler
    ticketActivityController --> asyncHandler

    authController --> sendResponse
    profileController --> sendResponse
    projectController --> sendResponse
    ticketController --> sendResponse
    ticketCommentController --> sendResponse
    ticketActivityController --> sendResponse

    sendResponse -->|"HTTP Response JSON"| Client
    Server --> errorHandler
    errorHandler --> Client

    %% Click Events
    click Server "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/server.ts"
    click authMW "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/middleware/Authmiddleware.ts"
    click errorHandler "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/middleware/errorHandler.ts"
    click validateRequest "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/middleware/validateRequest.ts"
    click validateTicket "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/middleware/validateTicket.ts"
    click authRouter "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/routes/authRouter.ts"
    click profileRouter "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/routes/profileRouter.ts"
    click projectsRouter "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/routes/projectsRouter.ts"
    click ticketsRouter "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/routes/ticketsRouter.ts"
    click ticketCommentsRouter "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/routes/ticketCommentsRouter.ts"
    click ticketActivityRouter "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/routes/ticketActivityRouter.ts"
    click authController "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/controllers/authController.ts"
    click profileController "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/controllers/profileController.ts"
    click projectController "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/controllers/projectController.ts"
    click ticketController "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/controllers/ticketController.ts"
    click ticketCommentController "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/controllers/ticketCommentController.ts"
    click ticketActivityController "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/controllers/ticketActivityController.ts"
    click ticketService "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/services/ticketService.ts"
    click supabaseClient "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/config/supabaseClient.ts"
    click zodValidators "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/validators/zodValidation.ts"
    click zodUtils "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/zod/zodValidation.ts"
    click asyncHandler "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/utils/asyncHandler.ts"
    click sendResponse "https://github.com/rohit8bitcoder/devdesk/blob/main/backend/src/utils/sendResponse.ts"

    %% Styles
    classDef gateway fill:#e0f7fa,stroke:#006064
    classDef middleware fill:#fff3e0,stroke:#e65100
    classDef router fill:#e3f2fd,stroke:#1565c0
    classDef controller fill:#bbdefb,stroke:#0d47a1
    classDef service fill:#c8e6c9,stroke:#2e7d32
    classDef db fill:#eeeeee,stroke:#424242
    classDef external fill:#f5f5f5,stroke:#9e9e9e
    classDef util fill:#f3e5f5,stroke:#6a1b9a
```
