How ridos/todo-app works
Project Type and Purpose
• This is a monolithic RESTful API server written in Go that implements a Todo application. It follows a layered (“Clean”) architecture separating transport (HTTP), business logic, and data access. It uses Postgres for persistence and Docker for local development.
High-Level Components
a. API Server
• Entry point: cmd/main.go → loads config (configs/config.yml + .env), initializes router and middleware (server.go), and starts the HTTP listener.
b. Handler Layer (Transport)
• Directory: pkg/handlers/
• Files: auth.go, item.go, list.go, middleware.go, response.go
• Responsibilities: parse HTTP requests, validate input, enforce auth middleware, format HTTP responses.
c. Service Layer (Business Logic)
• Directory: pkg/service/
• Files: auth.go, todo_item.go, todo_list.go, service.go
• Responsibilities: orchestrate use cases (e.g., create list, add item), apply domain rules, call repository.
d. Repository Layer (Data Access)
• Directory: pkg/repository/
• Files: auth_postgres.go, todo_item_postgres.go, todo_list_postgres.go, postgres.go, repository.go
• Responsibilities: connect to Postgres, run SQL queries, map rows to domain models.
e. Database
• Postgres container (instructions in README)
• Migrations in schema/1.sql, schema/2.sql
f. Configuration & Deployment
• Config in configs/config.yml and .env
• Docker for Postgres setup
• Go modules in go.mod/go.sum
Component Interactions & Data Flow
1. Client (e.g., browser, Postman) → HTTP Request
2. Router & Middleware (server.go + pkg/handlers/middleware.go)
3. Handler (pkg/handlers/*.go)
4. Service (pkg/service/*.go)
5. Repository (pkg/repository/*.go)
6. Postgres DB (schema/*.sql)
7. Back up chain: DB → Repo → Service → Handler → Client response
Architectual Patterns & Principles
• Layered (Clean) Architecture: decouple transport, business, data layers
• Dependency Injection: pass repository interfaces into services
• Single Responsibility: each package/file has a clear role
• Configuration-driven: externalize DB credentials and ports
Detail Orientation
• Environment variables (.env) feeding into config loader.
• Docker container boundary around Postgres.