README
¶
Overview
This template is very simple clean architecture template for Go. It is based on https://github.com/evrone/go-clean-template.
Content
Quick start
Local development:
# install migrate, mockgen, swag
$ make bin-deps
# Postgres container up
$ make compose-up
# Run app with migrations
$ make run
# access http://localhost:8080/metrics, can see metrics
Integration tests (can be run in CI):
# DB, app + migrations, integration tests
$ make compose-up-integration-test
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
app
command
|
|
|
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag
|
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag |
|
internal
|
|
|
app
Package app configures and runs application.
|
Package app configures and runs application. |
|
controller/http/v1
Package v1 implements routing paths.
|
Package v1 implements routing paths. |
|
entity
Package entity defines main entities for business logic (services), data base mapping and HTTP response objects if suitable.
|
Package entity defines main entities for business logic (services), data base mapping and HTTP response objects if suitable. |
|
usecase
Package usecase implements application business logic.
|
Package usecase implements application business logic. |
|
pkg
|
|
|
httpserver
Package httpserver implements HTTP server.
|
Package httpserver implements HTTP server. |
|
postgres
Package postgres implements postgres connection.
|
Package postgres implements postgres connection. |
Click to show internal directories.
Click to hide internal directories.