Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tochemey/cos-go-sample
[Go] Chief-Of-State sample application
https://github.com/tochemey/cos-go-sample
Last synced: 5 days ago
JSON representation
[Go] Chief-Of-State sample application
- Host: GitHub
- URL: https://github.com/tochemey/cos-go-sample
- Owner: Tochemey
- Created: 2023-07-15T01:32:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-21T22:18:42.000Z (3 months ago)
- Last Synced: 2024-08-21T22:31:42.274Z (3 months ago)
- Language: Go
- Size: 85 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
## Sample Application
[](https://github.com/Tochemey/cos-go-sample/actions/workflows/build.yml)
[](https://codecov.io/gh/Tochemey/cos-go-sample)
### Overview
This is to demonstrate how to build a distributed and fault-tolerant event-sourcing/cqrs application in Go using [Chief of State](https://github.com/chief-of-state/chief-of-state).
The project adheres to [Semantic Versioning](https://semver.org) and [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
### Features
#### API Requests
- [Open Account](protos/local/accounts/v1/service.proto)
- [Credit Account](protos/local/accounts/v1/service.proto)
- [Debit Account](protos/local/accounts/v1/service.proto)
- [Get Account](protos/local/accounts/v1/service.proto)
#### Commands
- [OpenAccount](protos/local/accounts/v1/commands.proto)
- [CreditAccount](protos/local/accounts/v1/commands.proto)
- [DebitAccount](protos/local/accounts/v1/commands.proto)
#### Events
- [AccountOpened](protos/local/accounts/v1/events.proto)
- [AccountCredited](protos/local/accounts/v1/events.proto)
- [AccountDebited](protos/local/accounts/v1/events.proto)
#### State
- [BankAccount](protos/local/accounts/v1/state.proto)
#### Observability
- [Tracing](docker/otel-collector.yaml)
- [Metrics](docker/prometheus.yml)
### Quickstart
```bash
# download earthly using the following command on macos
brew install earthly/earthly/earthly
# clone the repo
git clone [email protected]:Tochemey/cos-go-sample.git
# update the git submodule
git submodule update --init
# generate the protobuf binaries and mocks
earthly +protogen
earthly +mock
# update the go dependencies
go mod tidy && go mod vendor
# build image
earthly +docker-image
# starts the prometheus, jaeger and postgres container
docker-compose up -d
# starts the application container
docker-compose --profile application up
# OTHER HELPFUL COMMANDS
# supervise app logs
docker-compose logs -f --tail="all" accounts
# view traces
http://localhost:16686
```