go-skel

README

Go skeleton base project

Directory summary

The following directories follow somewhat the clean architecture design.

• app/controller: external layer, only processes the request data and passes it to the business layer on app/usecase
• app/usecase: business layer, doesn't put code here related to request or databases. Uses the app/repository package if it needs to operate on the data.
• app/repository: data repository layer. Only this layer connects to the database. Reads and writes data to structs from app/model.
• app/model: Data definitions. There is no business logic in this layer.
• app/tasks: Background tasks to be run asynchronously.

The following directories handles the application procedures unrelated to the business logic.

• cmd: Entrypoint for the application on the command line.
• config: Application configuration read from the environment, config file or command line flags.
• db: migration files for the database.
• locales: project translations.
• oapi: OpenAPI spec and autogenerated code.
• pkg: code shareavble with other modules.
• test: data to seed database for the testcases.
• version: application version info (commit and build date).
• web: static files served from the API.