README
¶
Go-Kit: Energimind's General Purpose Go Project
This repository contains a general purpose Go project used in Energimind's product.
It includes utilities for working with host addresses, including functions for composing host addresses from specified addresses, ports, and default ports.
It also includes utilities for working with environment variables, including functions for reading environment variables.
It includes utilities for working with HTTP servers, including functions for starting and stopping HTTP servers.
In includes a collection of commonly used ID generators.
While these utilities are commonly used in Go microservices, they can be used in other types of projects as well.
Contributing
We welcome contributions from the community! If you'd like to contribute, please feel free to submit a pull request. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
Package env provides functionality for loading environment variables.
|
Package env provides functionality for loading environment variables. |
|
Package envconf simplifies the process of loading environment variables into a struct.
|
Package envconf simplifies the process of loading environment variables into a struct. |
|
Package hostutil provides utilities for working with host addresses.
|
Package hostutil provides utilities for working with host addresses. |
|
Package httpd implements an HTTP server with a complete lifecycle.
|
Package httpd implements an HTTP server with a complete lifecycle. |
|
Package idgen provides a collection of ID generators.
|
Package idgen provides a collection of ID generators. |
|
cuuid
Package cuuid provides a generator for condensed UUIDs.
|
Package cuuid provides a generator for condensed UUIDs. |
|
shortid
Package shortid provides a generator for short IDs.
|
Package shortid provides a generator for short IDs. |
|
uuid
Package uuid provides a generator for IDs based on UUIDs.
|
Package uuid provides a generator for IDs based on UUIDs. |
|
Package testutil contains utilities for testing.
|
Package testutil contains utilities for testing. |
|
crud
Package crud provides a set of tests for CRUD operations.
|
Package crud provides a set of tests for CRUD operations. |
|
mapping
Package mapping contains utilities for testing mapping between structs and enums.
|
Package mapping contains utilities for testing mapping between structs and enums. |
|
mongodb
Package mongodb provides a shared MongoDB container for testing purposes.
|
Package mongodb provides a shared MongoDB container for testing purposes. |
|
redis
Package redis provides a redis container for testing purposes.
|
Package redis provides a redis container for testing purposes. |