README
¶
Kit
A set of common packages for building applications in Go.
This code has been developed for use in Hardcore Go training classes and client projects. We will be working hard to maintain backwards compatibility with each package's API. A proper set of documentation is required and we will be working on this as well.
You should be vendoring the packages you choose to use. We recommend using govendor. This tool will vendor from the vendor folder associated with this project repo for the dependencies in use. It is recommended to use a project based repo with a single vendor folder for all your dependencies.
If you have any questions about vendoring or the use of these packages, please send me an email.
-- Bill
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth package provides API's for managing users who will be accessing our web API's and applications.
|
Package auth package provides API's for managing users who will be accessing our web API's and applications. |
|
crypto
Package crypto provides support for encrypting passwords and generating tokens for authentication support.
|
Package crypto provides support for encrypting passwords and generating tokens for authentication support. |
|
session
Package session provides a level of security for web tokens by giving them an expiration date and a lookup point for the user accessing the API.
|
Package session provides a level of security for web tokens by giving them an expiration date and a lookup point for the user accessing the API. |
|
Package cfg provides configuration options that are loaded from the environment.
|
Package cfg provides configuration options that are loaded from the environment. |
|
cmd
|
|
|
kit
This program provides the kit project a basic cli tool to manage entities.
|
This program provides the kit project a basic cli tool to manage entities. |
|
Package db abstracts different database systems we can use.
|
Package db abstracts different database systems we can use. |
|
mongo
Package mongo provides support for using MongoDB.
|
Package mongo provides support for using MongoDB. |
|
examples
|
|
|
mapstructure
Sample program to show how to use the mapstructure package to handle large JSON documents and flatten them out.
|
Sample program to show how to use the mapstructure package to handle large JSON documents and flatten them out. |
|
pool
Sample program to show how to use the pool package to build pools of goroutines to get work done.
|
Sample program to show how to use the pool package to build pools of goroutines to get work done. |
|
runner
Sample program to show how to use the runner package to build tasks that must run within a well defined duration.
|
Sample program to show how to use the runner package to build tasks that must run within a well defined duration. |
|
tcp
Sample program to show how to use the tcp package to build servers that can accept tcp connections and send messages.
|
Sample program to show how to use the tcp package to build servers that can accept tcp connections and send messages. |
|
udp
Sample program to show how to use the udp package to build servers that can accept udp connections and send messages.
|
Sample program to show how to use the udp package to build servers that can accept udp connections and send messages. |
|
web/handlers
Package handlers contains the handler logic for processing requests.
|
Package handlers contains the handler logic for processing requests. |
|
Package log provides a simple layer above the standard library logging package.
|
Package log provides a simple layer above the standard library logging package. |
|
Package mapstructure is a Go library for decoding generic map values to structures and vice versa, while providing helpful error handling.
|
Package mapstructure is a Go library for decoding generic map values to structures and vice versa, while providing helpful error handling. |
|
Package pool manages a pool of routines to perform work.
|
Package pool manages a pool of routines to perform work. |
|
Package runner provide support for writing tasks that must complete within a certain duration or they must be killed.
|
Package runner provide support for writing tasks that must complete within a certain duration or they must be killed. |
|
Package tcp provides the boilerpale code for working with TCP based data.
|
Package tcp provides the boilerpale code for working with TCP based data. |
|
Package tests provides the generic support all tests require.
|
Package tests provides the generic support all tests require. |
|
Package timezone provides two ways to retrieve the timezone for any latitude,longitude position.
|
Package timezone provides two ways to retrieve the timezone for any latitude,longitude position. |
|
Package udp provides the boilerpale code for working with UDP based data.
|
Package udp provides the boilerpale code for working with UDP based data. |
|
web
|
|
|
app
Package app provides a thin layer of support for writing web services.
|
Package app provides a thin layer of support for writing web services. |
Click to show internal directories.
Click to hide internal directories.