# jurazodda/mini-blog architecture

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

- Interactive diagram: https://gitdiagram.com/jurazodda/mini-blog
- Repository: https://github.com/jurazodda/mini-blog

## Overview

##### Project type and purpose
- This is a backend microservice: a RESTful Mini-Blog platform written in Go.
- Purpose: expose HTTP endpoints for user authentication, posts, comments, likes, and reposts; persist data in PostgreSQL; log events.

##### File structure
- cmd/
- main.go – application entrypoint (loads config, initializes router & services)
- migrate.go – migration entrypoint
- config/
- config.go – centralizes env/config parsing
- internal/
- handler/ – HTTP layer using Gin: auth, post, comment, like, repost, middleware, router setup, server startup
- service/ – business logic per domain (user, post, comment, like, repost)
- repository/ – data access with Gorm: repositories for each model, DB connection setup
- models/ – shared domain models
- errs/ – error definitions
- pkg/glog/ – wrapper around Zerolog for structured logging
- logs/ – persisted log files
- mini-blog.sql – database schema
- go.mod, Makefile, .gitignore – build/config scripts

##### README for additional insights
- Uses Gin (HTTP server), Gorm (ORM), PostgreSQL, Zerolog
- Features: registration/login, CRUD posts, comments, likes, reposts

a. Main components:
- Clients (Web/Mobile/UI)
- API Gateway / HTTP Server (Gin)
- Handlers (Gin routes & controllers)
- Service Layer (business logic)
- Repository Layer (Gorm + PostgreSQL)
- Configuration Loader
- Logging subsystem (pkg/glog + Zerolog)
b. Relationships and data flow:
1. Client → HTTP Request → Gin Router
2. Router → Handler
3. Handler → Service (enforces business rules, authorization)
4. Service → Repository (CRUD via Gorm)
5. Repository → PostgreSQL
6. Handler → HTTP Response → Client
7. Throughout: Logging at each layer via glog → writes to logs/*.log
c. Architectural patterns:
- Layered (Controller/Service/Repository)
- Hexagonal-ish: external systems (DB, clients) connected through well-defined ports (handlers, repos)
- Dependency injection via “config” and pass-around of interfaces
d. Technologies and frameworks:
- Gin: HTTP router & middleware
- Gorm: ORM connecting repository layer to PostgreSQL
- Zerolog (wrapped by pkg/glog) for structured, leveled logging
- JWT in handler/jwt.go for stateless authentication

##### Detailed breakdown
- Startup sequence: cmd/main.go → config loader → initialize DB & logger → register routes → start Gin server
- Authentication flow:
- Handler/auth.go ↔ Service/user.go ↔ Repository/user_repo.go
- JWT middleware in handler/jwt.go validating tokens on protected routes
- CRUD flows for posts, comments, likes, reposts, each following the Handler → Service → Repository → DB path
- Error handling via internal/errs propagated up to Handlers → HTTP error responses
- Logging calls at each layer, captured by pkg/glog → logs/*.log

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Startup & Initialization
    Main["cmd/main.go\n(Application Entry Point)"]:::config
    Config["config/config.go\n(Configuration Loader)"]:::config
    DBConn["internal/repository/db.go\n(DB Connection Setup)"]:::repo
    LoggerWrapper["pkg/glog/glog.go\n(Structured Logging Wrapper)"]:::config

    Main -->|"loads config"| Config
    Main -->|"init DB"| DBConn
    Main -->|"init logger"| LoggerWrapper
    Main -->|"start server"| ServerInit

    %% HTTP Server & Routing
    ServerInit["internal/handler/server.go\n(HTTP Server Initialization)"]:::http
    Routes["internal/handler/routes.go\n(Router Setup)"]:::http

    ServerInit -->|"register routes"| Routes
    Routes --> Client

    %% External Client
    Client["Client Apps\n(Web/Mobile)"]:::external
    Client -->|"HTTP/JSON"| GinServer

    GinServer["Gin HTTP Server"]:::http
    GinServer --> Middleware

    %% Middleware
    Middleware["internal/handler/middleware.go\n(General Middleware)"]:::http
    Middleware --> JWTMiddleware
    Middleware --> AuthHandler
    Middleware --> PostHandler
    Middleware --> CommentHandler
    Middleware --> LikeHandler
    Middleware --> RepostHandler

    JWTMiddleware["internal/handler/jwt.go\n(JWT Middleware)"]:::http

    %% Handlers Layer
    AuthHandler["internal/handler/auth.go\n(Authentication Handler)"]:::http
    PostHandler["internal/handler/post.go\n(Post Handler)"]:::http
    CommentHandler["internal/handler/comment.go\n(Comment Handler)"]:::http
    LikeHandler["internal/handler/like.go\n(Like Handler)"]:::http
    RepostHandler["internal/handler/repost.go\n(Repost Handler)"]:::http

    %% Service Layer
    UserService["internal/service/user.go\n(User Service)"]:::service
    PostService["internal/service/post_service.go\n(Post Service)"]:::service
    CommentService["internal/service/comment_service.go\n(Comment Service)"]:::service
    LikeService["internal/service/like_service.go\n(Like Service)"]:::service
    RepostService["internal/service/repost_service.go\n(Repost Service)"]:::service

    AuthHandler -->|"calls"| UserService
    PostHandler -->|"calls"| PostService
    CommentHandler -->|"calls"| CommentService
    LikeHandler -->|"calls"| LikeService
    RepostHandler -->|"calls"| RepostService

    %% Repository Layer
    UserRepo["internal/repository/user_repo.go\n(User Repository)"]:::repo
    PostRepo["internal/repository/post_repo.go\n(Post Repository)"]:::repo
    CommentRepo["internal/repository/comment_repo.go\n(Comment Repository)"]:::repo
    LikeRepo["internal/repository/like_repo.go\n(Like Repository)"]:::repo
    RepostRepo["internal/repository/repost_repo.go\n(Repost Repository)"]:::repo

    UserService -->|"uses"| UserRepo
    PostService -->|"uses"| PostRepo
    CommentService -->|"uses"| CommentRepo
    LikeService -->|"uses"| LikeRepo
    RepostService -->|"uses"| RepostRepo

    %% Database & Models
    Models["internal/models/models.go\n(Shared Domain Models)"]:::config
    Errors["internal/errs/errors.go\n(Error Definitions)"]:::config
    DB["PostgreSQL\n(cylinder)"]:::db
    Schema["mini-blog.sql\n(Database Schema Script)"]:::config

    DBConn --> DB
    UserRepo --> DB
    PostRepo --> DB
    CommentRepo --> DB
    LikeRepo --> DB
    RepostRepo --> DB

    %% Logging
    Logs["logs/*.log\n(Persisted Log Files)"]:::config
    AuthHandler -->|"logs"| LoggerWrapper
    PostHandler -->|"logs"| LoggerWrapper
    CommentHandler -->|"logs"| LoggerWrapper
    LikeHandler -->|"logs"| LoggerWrapper
    RepostHandler -->|"logs"| LoggerWrapper
    UserService -->|"logs"| LoggerWrapper
    PostService -->|"logs"| LoggerWrapper
    CommentService -->|"logs"| LoggerWrapper
    LikeService -->|"logs"| LoggerWrapper
    RepostService -->|"logs"| LoggerWrapper
    LoggerWrapper --> Logs

    %% Click Events
    click Main "https://github.com/jurazodda/mini-blog/blob/master/cmd/main.go"
    click Config "https://github.com/jurazodda/mini-blog/blob/master/config/config.go"
    click ServerInit "https://github.com/jurazodda/mini-blog/blob/master/internal/handler/server.go"
    click Routes "https://github.com/jurazodda/mini-blog/blob/master/internal/handler/routes.go"
    click AuthHandler "https://github.com/jurazodda/mini-blog/blob/master/internal/handler/auth.go"
    click PostHandler "https://github.com/jurazodda/mini-blog/blob/master/internal/handler/post.go"
    click CommentHandler "https://github.com/jurazodda/mini-blog/blob/master/internal/handler/comment.go"
    click LikeHandler "https://github.com/jurazodda/mini-blog/blob/master/internal/handler/like.go"
    click RepostHandler "https://github.com/jurazodda/mini-blog/blob/master/internal/handler/repost.go"
    click JWTMiddleware "https://github.com/jurazodda/mini-blog/blob/master/internal/handler/jwt.go"
    click Middleware "https://github.com/jurazodda/mini-blog/blob/master/internal/handler/middleware.go"
    click UserService "https://github.com/jurazodda/mini-blog/blob/master/internal/service/user.go"
    click PostService "https://github.com/jurazodda/mini-blog/blob/master/internal/service/post_service.go"
    click CommentService "https://github.com/jurazodda/mini-blog/blob/master/internal/service/comment_service.go"
    click LikeService "https://github.com/jurazodda/mini-blog/blob/master/internal/service/like_service.go"
    click RepostService "https://github.com/jurazodda/mini-blog/blob/master/internal/service/repost_service.go"
    click DBConn "https://github.com/jurazodda/mini-blog/blob/master/internal/repository/db.go"
    click UserRepo "https://github.com/jurazodda/mini-blog/blob/master/internal/repository/user_repo.go"
    click PostRepo "https://github.com/jurazodda/mini-blog/blob/master/internal/repository/post_repo.go"
    click CommentRepo "https://github.com/jurazodda/mini-blog/blob/master/internal/repository/comment_repo.go"
    click LikeRepo "https://github.com/jurazodda/mini-blog/blob/master/internal/repository/like_repo.go"
    click RepostRepo "https://github.com/jurazodda/mini-blog/blob/master/internal/repository/repost_repo.go"
    click Models "https://github.com/jurazodda/mini-blog/blob/master/internal/models/models.go"
    click Errors "https://github.com/jurazodda/mini-blog/blob/master/internal/errs/errors.go"
    click LoggerWrapper "https://github.com/jurazodda/mini-blog/blob/master/pkg/glog/glog.go"

    %% Styles
    classDef http fill:#E0F7FA,stroke:#006064,color:#006064
    classDef service fill:#E8F5E9,stroke:#1B5E20,color:#1B5E20
    classDef repo fill:#FFF3E0,stroke:#E65100,color:#E65100
    classDef config fill:#ECEFF1,stroke:#455A64,color:#455A64
    classDef external fill:#F3E5F5,stroke:#4A148C,color:#4A148C
    classDef db fill:#FFEBEE,stroke:#B71C1C,color:#B71C1C
```
