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.
This project layout is intentionally generic and it doesn't try to impose a specific Go package structure.
Clone the repository, keep what you need and delete everything else!
Go Project Layout - additional background information.
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. If you think the code can be imported and used in other projects, then it should live in the /pkg directory. If the code is not reusable or if you don't want others to reuse it, put that code in the /internal directory. You'll be surprised what others will do, so be explicit about your intentions!
It's common to have a small main function that imports and invokes the code from the /internal and /pkg directories and nothing else.
Private application and library code. This is the code you don't want others importing in their applications or libraries.
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.
OpenAPI/Swagger specs, JSON schema files, protocol definition files.
Web application specific components: static web assets, server side templates and SPAs.
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).
Git hooks.
Other assets to go along with your repository.
Some Go projects do have a src folder, but it usually happens when the devs came from the Java world where it's a common pattern. If you can help yourself try not to adopt this Java pattern. You really don't want your Go code or Go projects to look like Java :-)
-
Go Report Card - It will scan your code with
gofmt,go vet,gocyclo,golint,ineffassign,licenseandmisspell. Replacegithub.com/golang-standards/project-layoutwith your project reference. -
GoDoc - It will provide online version of your GoDoc generated documentation. Change the link to point to your project.
-
Release - It will show the latest release number for your project. Change the github link to point to your project.
A more opinionated project template with sample/reusable configs, scripts and code is a WIP.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent