README
¶
service3-video
Getting Started
- Install prerequisites
- Pull down Repository
- Run
make all - Run
make kind-up - Run
make kind-load - Run
make kind-apply
Endpoints
GET http://localhost:4000/debug/liveness - Service Information
GET http://localhost:4000/debug/readiness - Checks if the project is ready
GET http://localhost:3000/v1/test - Test Endpoint
Running Metrics
- In a terminal
go get github.com/divan/expvarmon - In a terminal
expvarmon -ports=":4000" -vars="build,requests,goroutines,errors,panics,mem:memstats.Alloc"
Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
services/sales-api/handlers
Package handlers manages the different versions of the API.
|
Package handlers manages the different versions of the API. |
|
services/sales-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/sales-api/handlers/v1/testgrp
Package testgrp contains all the test handlers
|
Package testgrp contains all the test handlers |
|
services/sales-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. |
|
data/schema
Package schema contains the database schema, migrations and seeding data.
|
Package schema contains the database schema, migrations and seeding data. |
|
data/store/user
Package user contains user related CRUD functionality.
|
Package user contains user related CRUD functionality. |
|
data/tests
Package tests contains supporting code for running tests
|
Package tests contains supporting code for running tests |
|
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 constructs the metrics the application will track.
|
Package metrics constructs 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/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.KeyLookup interface.
|
Package keystore implements the auth.KeyLookup interface. |
|
logger
Package logger provides a convenience function to constructing a logger for use.
|
Package logger provides a convenience function to constructing a logger for use. |
|
web
Package web contains a small web framework extenstion
|
Package web contains a small web framework extenstion |
Click to show internal directories.
Click to hide internal directories.