This is a basic layout for Go application projects. It represents the most common directory structure with a number of small enhancements along with several supporting directories common to any real world application.
Main applications for this project. The directory name for each application should match the name of the executable you want to have (e.g., /cmd/myapp). Don't put a lot of code in the application directory unless you think that code can be imported and used in other projects. If this is the case then the code should live in the /pkg directory. It's common to have a small main function that imports and invokes the code from the /internal and /pkgdirectories.
Private application and library code. Put your actual application code in the /internal/app directory (e.g., /internal/app/myapp) and the code shared by those apps in the /internal/pkg directory (e.g., /internal/pkg/myprivlib).
Library code that's safe to use by external applications (e.g., /pkg/mypubliclib).
Other projects will import these libraries expecting them to work, so think twice before you put something here :-)
Application dependencies (managed manually or by your favorite dependency management tool).
Don't commit your application dependencies if you are building a library.
Service Application Directories
OpenAPI/Swagger specs, JSON schema files, protocol definition files.
Web Application Directories
Web application specific components: static web assets, server side templates and SPAs.
Common Application Directories
Configuration file templates or default configs.
Put your confd or consule-template template files here.
System init (systemd, upstart, sysv) and process manager/supervisor (runit, supervisord) configs.
Scripts to perform various build, install, analysis, etc operations.
These scripts keep the root level Makefile small and simple.
Packaging and Continous Integration.
Put your cloud (AMI), container (Docker), OS (deb, rpm, pkg) package configurations and scripts in the /build/package directory.
Put your CI (travis, circle, drone) configurations and scripts in the /build/ci directory.
IaaS, PaaS, system and container orchestration deployment configurations and templates (docker-compose, kubernetes/helm, mesos, terraform, bosh).
Additional external test apps and test data.
Design and user documents (in addition to your godoc generated documentation).
Supporting tools for this project. Note that these tools can import code from the /pkg and /internal directories.
Examples for your applications and/or public libraries.
External helper tools, forked code and other 3rd party utilities (e.g., Swagger UI).
Other assets to go along with your repository.
[Golang] The project directory structure Reviewed by Anh Dung on 10:58 AM Rating: 5