sosokker/go-chi-oapi-codegen-todolist
1
0
Fork 0
mirror of https://github.com/Sosokker/go-chi-oapi-codegen-todolist.git synced 2025-12-19 05:54:07 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Sirin Puenggun 2025-04-21 22:23:17 +07:00 committed by GitHub
parent e6b132a343
commit 14016fc268
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 41 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -106,7 +106,7 @@ The app should now run at `http://localhost:3000`.
* **Frontend:** Creates user interface and manages user interactions * **Frontend:** Creates user interface and manages user interactions
* **Communication:** Frontend sends HTTP requests to backend API endpoints * **Communication:** Frontend sends HTTP requests to backend API endpoints
### Backend Architecture (Hexagonal): ### Backend Architecture - Hexagonal (Ports & Adapters):
The backend follows a "ports and adapters" pattern for better separation of concerns: The backend follows a "ports and adapters" pattern for better separation of concerns:
@ -118,6 +118,46 @@ The backend follows a "ports and adapters" pattern for better separation of conc
* Database repositories (connect services to database) * Database repositories (connect services to database)
* Storage service (connects to Google Cloud) * Storage service (connects to Google Cloud)
The goal is to **decouple core business logic** from external systems such as databases, web frameworks, and third-party APIs.
#### Core (Inside the Hexagon)
- Contains essential **business rules and domain logic**
- Located in:
- `internal/domain`: Domain models and error definitions
- `internal/service`: Use cases and service logic
- The core is **technology-agnostic** and has **no knowledge** of infrastructure or frameworks
#### Ports (Hexagon Boundary Interfaces)
Interfaces that define how the core interacts with the outside world.
- **Driving Ports** (Input Interfaces)
- Describe how the application can be used
- Example: `TodoService` interface defines operations like `CreateTodo`, `ListTodos`
- Implemented in the **application layer** (`internal/service`)
- **Driven Ports** (Output Interfaces)
- Describe how the application depends on external systems
- Example: `TodoRepository`, `FileStorageService` interfaces
- Defined in service or repository packages as needed
#### Adapters (Outside the Hexagon)
Concrete implementations that **connect ports to external systems**.
- **Driving Adapters**
- Translate external input (HTTP, CLI, etc.) into calls to the core via driving ports
- Example:
- HTTP handlers in `internal/api` invoke `TodoService` methods
- Middleware handles auth and CORS
- **Driven Adapters**
- Provide infrastructure-specific implementations of driven ports
- Examples:
- `pgxTodoRepository` in `internal/repository` implements `TodoRepository` using PostgreSQL
- `gcsStorageService` in `internal/service` implements `FileStorageService` using GCS
### Frontend Architecture: ### Frontend Architecture:
1. **Pages & Routes:** In the `app/` folder using Next.js App Router 1. **Pages & Routes:** In the `app/` folder using Next.js App Router