lightair/project-layout
1
0
Fork 0
mirror of https://github.com/golang-standards/project-layout.git synced 2026-02-04 06:06:18 +00:00
Code Issues Projects Releases Wiki Activity

adding layout references

Browse Source
This commit is contained in:
Kyle Quest
2018-04-28 22:33:08 -07:00
parent 6298595c9e
commit 55ba244c26
7 changed files with 38 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -20,6 +20,8 @@ Don't put a lot of code in the application directory. If you think the code can
It's common to have a small `main` function that imports and invokes the code from the `/internal` and `/pkg` directories and nothing else.
See the `/cmd` directory for examples.
### `/internal`
Private application and library code. This is the code you don't want others importing in their applications or libraries.
@@ -44,6 +46,8 @@ Don't commit your application dependencies if you are building a library.
OpenAPI/Swagger specs, JSON schema files, protocol definition files.
See the `/api` directory for examples.
## Web Application Directories
### `/web`
@@ -84,20 +88,28 @@ IaaS, PaaS, system and container orchestration deployment configurations and tem
Additional external test apps and test data.
See the `/test` directory for examples.
## Other Directories
### `/docs`
Design and user documents (in addition to your godoc generated documentation).
See the `/docs` directory for examples.
### `/tools`
Supporting tools for this project. Note that these tools can import code from the `/pkg` and `/internal` directories.
See the `/tools` directory for examples.
### `/examples`
Examples for your applications and/or public libraries.
See the `/examples` directory for examples.
### `/third_party`
External helper tools, forked code and other 3rd party utilities (e.g., Swagger UI).