README
¶
Foundation Kit
This project contains very opinionated packages for common operations.
Getting Started
These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.
Prerequisites
Requirements for the software and other tools to build, test and push:
- go
- golangci-lint: for linting.
Linting
Please run golangci-lint run before submitting code.
Godoc
To read the godoc documentation run:
godoc -http=localhost:6060
and open http://localhost:6060 on your browser.
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.
License
This project is licensed under the BSD 3-Clause - see the LICENSE.md file for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package app provides an application framework that manages the live cycle of a running application.
|
Package app provides an application framework that manages the live cycle of a running application. |
|
examples/panic
command
|
|
|
examples/servefiles
command
|
|
|
example
command
This is a simple example that shows how to use avroutil package.
|
This is a simple example that shows how to use avroutil package. |
|
metricsmiddleware/v2/example
command
This is a simple example that shows how to setup the metrics middleware.
|
This is a simple example that shows how to setup the metrics middleware. |
|
metricsmiddleware/v3/example
command
This is a simple example that shows how to setup the metrics middleware.
|
This is a simple example that shows how to setup the metrics middleware. |
|
metricsmiddleware/v4/example
command
This is a simple example that shows how to setup the metrics middleware.
|
This is a simple example that shows how to setup the metrics middleware. |
|
httpmiddlewares
|
|
|
Package request provides helper functions to handle Request ID propagation.
|
Package request provides helper functions to handle Request ID propagation. |
|
sefaz
|
|
|
Package trace provides distributed tracing.
|
Package trace provides distributed tracing. |
|
v2/examples/cmd/api
command
|
|