Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thangchung/go-coffeeshop

☕ A practical event-driven microservices demo built with Golang. Nomad, Consul Connect, Vault, and Terraform for deployment
https://github.com/thangchung/go-coffeeshop

alpinejs clean-architecture consul-connect ddd dependency-injection echo-framework event-driven-architecture event-driven-microservices golang grpc-gateway microservices nomad postgresql rabbitmq sqlc terraform vertical-slice-architecture wire

Last synced: 6 days ago
JSON representation

☕ A practical event-driven microservices demo built with Golang. Nomad, Consul Connect, Vault, and Terraform for deployment

Host: GitHub
URL: https://github.com/thangchung/go-coffeeshop
Owner: thangchung
License: mit
Created: 2022-09-18T14:10:42.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-05-10T01:17:45.000Z (over 1 year ago)
Last Synced: 2024-11-29T00:04:35.779Z (13 days ago)
Topics: alpinejs, clean-architecture, consul-connect, ddd, dependency-injection, echo-framework, event-driven-architecture, event-driven-microservices, golang, grpc-gateway, microservices, nomad, postgresql, rabbitmq, sqlc, terraform, vertical-slice-architecture, wire
Language: Go
Homepage:
Size: 2.39 MB
Stars: 4,153
Watchers: 43
Forks: 425
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-ccamel - thangchung/go-coffeeshop - ☕ A practical event-driven microservices demo built with Golang. Nomad, Consul Connect, Vault, and Terraform for deployment (Go)
my-awesome - thangchung/go-coffeeshop - architecture,consul-connect,ddd,dependency-injection,echo-framework,event-driven-architecture,event-driven-microservices,golang,grpc-gateway,microservices,nomad,postgresql,rabbitmq,sqlc,terraform,vertical-slice-architecture,wire pushed_at:2023-05 star:4.2k fork:0.4k ☕ A practical event-driven microservices demo built with Golang. Nomad, Consul Connect, Vault, and Terraform for deployment (Go)

README

        # go-coffeeshop

An event-driven microservices coffee shop application has been written in Golang and deployed using Nomad, Consul Connect, Vault, and Terraform.

Other versions in .NET/C# can be found at:

- [.NET CoffeeShop with Microservices approach](https://github.com/thangchung/coffeeshop-on-nomad)

- [.NET CoffeeShop with Modular Monolith approach](https://github.com/thangchung/coffeeshop-modular)

## Technical stack

- Backend building blocks

  - [grpc-ecosystem/grpc-gateway/v2](https://github.com/grpc-ecosystem/grpc-gateway)

  - [labstack/echo/v4](https://github.com/labstack/echo)

  - [rabbitmq/amqp091-go](https://github.com/rabbitmq/amqp091-go)

  - [kyleconroy/sqlc](https://github.com/kyleconroy/sqlc)

    - [pq](github.com/lib/pq)

  - [golang-migrate/migrate/v4](https://github.com/golang-migrate/migrate)

  - Utils

    - [google/wire](github.com/google/wire)

    - [ilyakaznacheev/cleanenv](https://github.com/ilyakaznacheev/cleanenv)

    - golang.org/x/exp/slog

      - [sirupsen/logrus](https://github.com/sirupsen/logrus)

    - [samber/lo](https://github.com/samber/lo)

    - [automaxprocs/maxprocs](go.uber.org/automaxprocs/maxprocs)

    - [stretchr/testify](github.com/stretchr/testify)

    - golang/glog

    - google/uuid

    - google.golang.org/genproto

    - google.golang.org/grpc

    - google.golang.org/protobuf

- Infrastructure

  - Postgres, RabbitMQ

  - Hashicorp Nomad, Consul (Connect), Vault, Terraform

  - docker and docker-compose

  - devcontainer for reproducible development environment

## CoffeeShop - Choreography Saga

![coffeeshop](docs/coffeeshop.svg)

## Services

No. | Service | URI

--- | --- | ---

1 | grpc-gateway | [http://localhost:5000](http://localhost:5000)

2 | product service | [http://localhost:5001](http://localhost:5001)

3 | counter service | [http://localhost:5002](http://localhost:5002)

4 | barista service | worker only

5 | kitchen service | worker only

6 | web | [http://localhost:8888](http://localhost:8888)

## Starting project

Jump into [`.devcontainer`](https://code.visualstudio.com/docs/devcontainers/containers), then

```bash

> make docker-compose

```

From `vscode` => Press F1 => Type `Simple Browser View` => Choose it and enter [http://localhost:8888](http://localhost:8888).

Enjoy!!!

## Screenshots

### Home screen

![home_screen](docs/home_screen.png)

### Payment screen

![payment_screen](docs/payment_screen.png)

### Order list screen

![order_list_screen](docs/order_list_screen.png)

## HashiCorp stack deployment

![coffeeshop_hashicorp](docs/coffeeshop_hashicorp.svg)

The details of how to run it can be find at [deployment with Nomad, Consult Connect and Vault](build/README.md).

## Development

### Clean Domain-driven Design

![clean_ddd](docs/clean_ddd.svg)

### Generate dependency injection instances with wire

```bash

> make wire

```

### Generate code with sqlc

```bash

> make sqlc

```

### Debug Apps

[Debug golang app in monorepo](https://github.com/thangchung/go-coffeeshop/wiki/Golang#debug-app-in-monorepo)

### Trouble shooting

[Development project trouble shooting](https://github.com/thangchung/go-coffeeshop/wiki#trouble-shooting)

## Roadmap

- ✅ Enhance project structure with DDD patterns

- Add testing

- Add and integrate with observability libs and tools

- Add user identity management (authentication and authorization)

- Add resiliency

## Credits

- [project-layout](https://github.com/golang-standards/project-layout)

- [repository-structure](https://peter.bourgon.org/go-best-practices-2016/#repository-structure)

- [go-build-template](https://github.com/thockin/go-build-template)

- [go-clean-template](https://github.com/evrone/go-clean-template)

- [emsifa/tailwind-pos](https://github.com/emsifa/tailwind-pos)