# radenraflyy/todorist-techical-test architecture

> Architecture diagram of the GitHub repository radenraflyy/todorist-techical-test, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/radenraflyy/todorist-techical-test
- Repository: https://github.com/radenraflyy/todorist-techical-test

## Overview

##### Project type and purpose
- This is a Go–based RESTful API server for a “todos” application with authentication, generating Swagger documentation via Swag (docs/swagger.{json,yaml}).
- It uses Prisma as its ORM (prisma/schema.prisma), follows a layered/module-based architecture, and exposes endpoints for auth and todo operations.

##### File structure
- Top-level:
- cmd/app, cmd/tmp_build: entry-point main packages
- env: alternative main.go (perhaps local/dev runner)
- server: HTTP server setup, middleware, and routers
- config: environment loader and database config
- internal: domain modules (auth, todos) in “controller → usecase → repository” layers
- pkg: reusable components (custom logging, exception handling, hash functions, JWT, password verification)
- prisma: database schema
- docs: Swagger metadata
- utils: small helper functions
- The separation of “internal” vs. “pkg” indicates business logic vs. shared libraries.

##### README for additional insights
- README only instructs how to generate Swagger docs:
swag init -g .\server\router\main.go -o docs

##### Elements
- Blue for transport (HTTP server, middleware, router)
- Green for application/business logic (controllers, use-cases)
- Orange for infrastructure (repository, Prisma, database)
- Grey for utilities/packages
- Annotations for main config files (config/database.go, load_env.go) at system init

##### Final advice
- Be detailed: include both auth and todos domains as separate modules
- Cross‐cutting dependencies: JWT, hashing, logging, exception handling
- Do not over-subdivide: stick to layers and modules as defined in the file tree

## Diagram (Mermaid)

```mermaid
flowchart TB
    Clients["Clients\n(Web/Mobile/Postman)"]:::external

    subgraph "Transport Layer"
        HTTPServer["HTTP Server\n(cmd/app/main.go)"]:::transport
        AltRunner["Alternative Runner\n(env/main.go)"]:::transport
        TmpBuild["Temp Build Entry\n(cmd/tmp_build/main.go)"]:::transport

        subgraph "Middleware Stack"
            CORS["CORS Middleware\n(server/middleware/cors.go)"]:::transport
            ErrorHandle["Error Handler\n(server/middleware/error_handle.go)"]:::transport
            MiddlewareGen["Generic Middleware\n(server/middleware/middleware.go)"]:::transport
        end

        Router["Core Router\n(server/router/main.go)"]:::transport
        AuthRouter["Auth Router\n(server/router/auth_router/main.go)"]:::transport
        TodosRouter["Todos Router\n(server/router/todos_router/main.go)"]:::transport
    end

    subgraph "Application Layer"
        subgraph "Auth Module"
            AuthController["Auth Controller\n(internal/auth/controller.go)"]:::app
            AuthUsecase["Auth Use-case\n(internal/auth/usecase.go)"]:::app
            AuthRepo["Auth Repository\n(internal/auth/repository.go)"]:::app
            AuthReqDTO["Auth DTOs\n(request.dto.go / response.dto.go)"]:::app
        end
        subgraph "Todos Module"
            TodosController["Todos Controller\n(internal/todos/controller.go)"]:::app
            TodosUsecase["Todos Use-case\n(internal/todos/usecase.go)"]:::app
            TodosRepo["Todos Repository\n(internal/todos/repository.go)"]:::app
            TodosReqDTO["Todos DTOs\n(request.dto.go / response.dto.go)"]:::app
        end
    end

    subgraph "Infrastructure Layer"
        Prisma["Prisma ORM\n(prisma/schema.prisma)"]:::infra
        Database["Database\n(PostgreSQL/MySQL)"]:::infra
    end

    subgraph "Utilities"
        subgraph "Config"
            LoadEnv["Load Env\n(config/load_env.go)"]:::util
            DBConfig["DB Config\n(config/database.go)"]:::util
        end
        subgraph "JWT Package"
            JWTClaims["claims.go\n(pkg/jwttoken/claims.go)"]:::util
            JWTMarker["jwt_marker.go\n(pkg/jwttoken/jwt_marker.go)"]:::util
        end
        Hash["Hashing\n(pkg/hash-function/main.go)"]:::util
        Verify["Password Verify\n(pkg/verify-password/main.go)"]:::util
        Logging["Custom Logging\n(pkg/customlog/main.go)"]:::util
        Exception["Exception Handling\n(pkg/exception/main.go)"]:::util
        Helpers["Shared Helpers\n(utils/*.go)"]:::util

        subgraph "Swagger Docs"
            SDJSON["swagger.json\n(docs/swagger.json)"]:::util
            SDYAML["swagger.yaml\n(docs/swagger.yaml)"]:::util
            DocsGo["docs.go\n(docs/docs.go)"]:::util
        end
    end

    Clients --> HTTPServer
    Clients --> AltRunner
    Clients --> TmpBuild

    HTTPServer --> LoadEnv
    HTTPServer --> DBConfig
    HTTPServer --> CORS
    CORS --> ErrorHandle
    ErrorHandle --> MiddlewareGen
    MiddlewareGen --> Router

    Router --> AuthRouter
    Router --> TodosRouter
    Router --> SDJSON
    Router --> SDYAML
    Router --> DocsGo

    AuthRouter --> AuthController
    TodosRouter --> TodosController

    AuthController --> AuthUsecase
    AuthController --> JWTClaims
    AuthController --> JWTMarker
    AuthController --> Hash
    AuthController --> Verify
    TodosController --> TodosUsecase

    AuthUsecase --> AuthRepo
    TodosUsecase --> TodosRepo
    AuthUsecase --> Logging
    TodosUsecase --> Logging
    AuthUsecase --> Exception
    TodosUsecase --> Exception

    AuthRepo --> Prisma
    TodosRepo --> Prisma
    Prisma --> Database
    DBConfig --> Prisma

    classDef transport fill:#cce5ff,stroke:#004085,color:#004085;
    classDef app fill:#d4edda,stroke:#155724,color:#155724;
    classDef infra fill:#ffeeba,stroke:#856404,color:#856404;
    classDef util fill:#e2e3e5,stroke:#6c757d,color:#6c757d;
    classDef external fill:#f8d7da,stroke:#721c24,color:#721c24;

    click HTTPServer "https://github.com/radenraflyy/todorist-techical-test/blob/main/cmd/app/main.go"
    click AltRunner "https://github.com/radenraflyy/todorist-techical-test/blob/main/env/main.go"
    click TmpBuild "https://github.com/radenraflyy/todorist-techical-test/blob/main/cmd/tmp_build/main.go"
    click CORS "https://github.com/radenraflyy/todorist-techical-test/blob/main/server/middleware/cors.go"
    click ErrorHandle "https://github.com/radenraflyy/todorist-techical-test/blob/main/server/middleware/error_handle.go"
    click MiddlewareGen "https://github.com/radenraflyy/todorist-techical-test/blob/main/server/middleware/middleware.go"
    click Router "https://github.com/radenraflyy/todorist-techical-test/blob/main/server/router/main.go"
    click AuthRouter "https://github.com/radenraflyy/todorist-techical-test/blob/main/server/router/auth_router/main.go"
    click TodosRouter "https://github.com/radenraflyy/todorist-techical-test/blob/main/server/router/todos_router/main.go"
    click AuthController "https://github.com/radenraflyy/todorist-techical-test/blob/main/internal/auth/controller.go"
    click AuthUsecase "https://github.com/radenraflyy/todorist-techical-test/blob/main/internal/auth/usecase.go"
    click AuthRepo "https://github.com/radenraflyy/todorist-techical-test/blob/main/internal/auth/repository.go"
    click TodosController "https://github.com/radenraflyy/todorist-techical-test/blob/main/internal/todos/controller.go"
    click TodosUsecase "https://github.com/radenraflyy/todorist-techical-test/blob/main/internal/todos/usecase.go"
    click TodosRepo "https://github.com/radenraflyy/todorist-techical-test/blob/main/internal/todos/repository.go"
    click Prisma "https://github.com/radenraflyy/todorist-techical-test/blob/main/prisma/schema.prisma"
    click SDJSON "https://github.com/radenraflyy/todorist-techical-test/blob/main/docs/swagger.json"
    click SDYAML "https://github.com/radenraflyy/todorist-techical-test/blob/main/docs/swagger.yaml"
    click DocsGo "https://github.com/radenraflyy/todorist-techical-test/blob/main/docs/docs.go"
    click JWTClaims "https://github.com/radenraflyy/todorist-techical-test/blob/main/pkg/jwttoken/claims.go"
    click JWTMarker "https://github.com/radenraflyy/todorist-techical-test/blob/main/pkg/jwttoken/jwt_marker.go"
    click Hash "https://github.com/radenraflyy/todorist-techical-test/blob/main/pkg/hash-function/main.go"
    click Verify "https://github.com/radenraflyy/todorist-techical-test/blob/main/pkg/verify-password/main.go"
    click Logging "https://github.com/radenraflyy/todorist-techical-test/blob/main/pkg/customlog/main.go"
    click Exception "https://github.com/radenraflyy/todorist-techical-test/blob/main/pkg/exception/main.go"
    click LoadEnv "https://github.com/radenraflyy/todorist-techical-test/blob/main/config/load_env.go"
    click DBConfig "https://github.com/radenraflyy/todorist-techical-test/blob/main/config/database.go"
```
