https://github.com/dotpep/clean-golang-api-boilerplate

Clean Golang WEB API Boilerplate or Example of Structuring.
https://github.com/dotpep/clean-golang-api-boilerplate

Last synced: 3 days ago
JSON representation

Clean Golang WEB API Boilerplate or Example of Structuring.

• Host: GitHub
• URL: https://github.com/dotpep/clean-golang-api-boilerplate
• Owner: dotpep
• Created: 2024-11-11T10:22:11.000Z (6 days ago)
• Default Branch: main
• Last Pushed: 2024-11-11T12:23:48.000Z (6 days ago)
• Last Synced: 2024-11-11T12:32:03.662Z (6 days ago)
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Golang Clean Codebase/Dirs structure for web/api (boilerblate, template and example)

**Links:**

- [GitHub repo - Standard Go Project Layout](https://github.com/golang-standards/project-layout)

- [GitHub repo - About: Go-blueprint allows users to spin up a quick Go project using a popular framework (Golang Project generator like Maven/Grandle, Django, npm React and etc.)](https://github.com/Melkeydev/go-blueprint)

**Additional:**

Maksim Zhashkevych:

- [Архитектура Golang приложений](https://youtu.be/B0lV7I3FO4E?si=LfsTeVrr0yg8tovP)

- [Архитектура Golang Приложений 2022 | Чистая Архитектура](https://youtu.be/mesl2Si6saw?si=oGpNN1eaaAT-clDd)

Oleg Kozyrev:

- [Чистая архитектура проекта на Golang](https://youtu.be/e-D28OoWsOg?si=pT_Es_QyhHDCLuco)

## Notes

- `/cmd` is main entrypoint for compiling executable files of Golang projects

Technologies:

- `Makefile` - aliases for cli/cmd commands

- `.env` - secrets (environment variable)

- `/configs/main.yml` - cfg constants/variables of our project

- `/docs/swagger` or just `/docs` can store swagger/openapi generated documentation and other things like ER-D of projects

Top layers:

- `/src`

    - will hold static files of GitHub repository

    - or we can store it in `/docs/src/`???

    - also if our project repo is for fullstack we can store statics of frontend in `/src` or `/internal/statics/`???

Sub layers:

### Docker, K8s and Dev/Prod staging Containers/Docker Composes

`docker-compose.yml` is for development stage

`/deployments/docker-compose.yml` or other or etc. things like for K8s for depleyments

Also we can divide our Dev stage docker-compose into: `/docker_compose/app.yml` and `/docker_compose/storages.yml`

- furthermore for better/comfort run our docker-composes or anything else we can use `Makefile` in Top layer

### About Tests, Unit Test, Integrate tests

we can store all tests in Top level layer: `/tests` or `/test`,

and also we can store tests in `/internal` like specific for Unit Tests and then Integrate tests will be in Top layer `/tests` and Unit tests in `/internal/tests/some_unit_tests.go`