README
¶
Prerequisites
- Go 1.18 (should still be backwards compatible with earlier versions)
Running locally
- From root of the repo
- Run
docker-compose upwill start the dependencies and server on port 8080
Running via docker
- From root of the repo
- Run
docker-compose upwill start the dependencies and server on port 8080
Postman
The collections will need an environment setup with scheme, port and host variables setup with values of http, 8080 and localhost respectively.
Run tests
Some of the integration tests use docker to spin up dependencies on demand (ie a postgres db) so just be aware that docker is needed to run the tests.
- From root of the repo
- Run
go test ./...
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
events
Package events represents a stub for producing events to a Kafka topic, a real implementation would contain logic for retrying failed events etc
|
Package events represents a stub for producing events to a Kafka topic, a real implementation would contain logic for retrying failed events etc |
|
users/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
Click to show internal directories.
Click to hide internal directories.