README
¶
Kit
Starter kit for writing services in Go.
Requirements
Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
services/users-api/handlers
Package handlers manages the different versions of the API.
|
Package handlers manages the different versions of the API. |
|
services/users-api/handlers/debug/checkgrp
Package checkgrp maintains the group of handlers for health checking.
|
Package checkgrp maintains the group of handlers for health checking. |
|
services/users-api/handlers/v1/testgrp
Package testgrp contains all the test handlers.
|
Package testgrp contains all the test handlers. |
|
services/users-api/handlers/v1/usergrp
Package usergrp maintains the group of handlers for user access.
|
Package usergrp maintains the group of handlers for user access. |
|
tooling/logfmt
This program takes the structured log output and makes it readable.
|
This program takes the structured log output and makes it readable. |
|
business
|
|
|
core/user
Package user provides an example of a core business API.
|
Package user provides an example of a core business API. |
|
core/user/db
Package db contains user related CRUD functionality.
|
Package db contains user related CRUD functionality. |
|
data/dbschema
Package dbschema contains the database schema, migrations and seeding data.
|
Package dbschema contains the database schema, migrations and seeding data. |
|
data/dbtest
Package dbtest contains supporting code for running tests that hit the DB.
|
Package dbtest contains supporting code for running tests that hit the DB. |
|
sys/auth
Package auth provides authentication and authorization support.
|
Package auth provides authentication and authorization support. |
|
sys/database
Package database provides support for access the database.
|
Package database provides support for access the database. |
|
sys/metrics
Package metrics cosntructs the metrics the application will track.
|
Package metrics cosntructs the metrics the application will track. |
|
sys/validate
Package validate contains the support for validating models.
|
Package validate contains the support for validating models. |
|
web/v1
Package v1 represents types used by the web application for v1.
|
Package v1 represents types used by the web application for v1. |
|
web/v1/mid
Package mid contains the set of middleware functions.
|
Package mid contains the set of middleware functions. |
|
foundation
|
|
|
docker
Package docker provides support for starting and stopping docker containers for running tests.
|
Package docker provides support for starting and stopping docker containers for running tests. |
|
keystore
Package keystore implements the auth.KeyStore interface.
|
Package keystore implements the auth.KeyStore interface. |
|
logger
Package logger provides a convience function to constructing a logger for use.
|
Package logger provides a convience function to constructing a logger for use. |
|
web
Package web contains a small web framework extension.
|
Package web contains a small web framework extension. |
Click to show internal directories.
Click to hide internal directories.