README.md

Golang API Starter Kit

Go Server/API boilerplate using best practices, DDD, CQRS, ES, gRPC.

Table of Contents

• About
• Documentation
• Example
  • Quick start
    • Build release
    • Install Cert Manager
    • Deploy release
  • Dashboard
  • Domain
    • Dispatching command
  • View
    • Public routes
    • Protected routes
• Sponsoring

ABOUT

The main purpose of this project is to provide boilerplate project setup using using best practices, DDD, CQRS, ES, gRPC. Featuring kubernetes for both development and production environments. Allowing to work with environment reflecting production one, allowing to reduce any misconfigurations.

This is mono-repository of many services such as authentication or user domain. Each service has it own code base with exception of shared packages to simplify things for this boilerplate. Services communicate witch each other using gRPC. Each service might expose HTTP API for external communication or/and gRPC.

This project setup should reduce the time spent on environment configuration for the whole kubernetes cluster and/or each of microservice. Extracting each of services to own repository or keeping it as mono-repo should be a matter of preference.

Key concepts:

1. Rest API
2. Docker
3. Kubernetes
4. Helm chart
5. gRPC
6. Domain Driven Design (DDD)
7. CQRS
8. Event Sourcing
9. Hexagonal, Onion, Clean Architecture
10. oAuth2

Worth getting to know packages used in this boilerplate:

1. gorouter
2. message-bus
3. gollback
4. shutdown
5. pubsub
6. ardanlabs/service

DOCUMENTATION

• Wiki
• Package level docs
• Getting Started
• Installing and Setting up
• Configuration
• Guides

EXAMPLE

Quick start

Build release

make docker-build BIN=auth
make docker-build BIN=migrate
make docker-build BIN=user

Install Cert Manager

kubectl apply -f https://raw.githubusercontent.com/jetstack/cert-manager/release-0.12/deploy/manifests/00-crds.yaml

helm repo add jetstack https://charts.jetstack.io
helm repo update

make helm-dependencies

Deploy release

make helm-install

Dashboard

https://go-api-boilerplate.local/dashboard/#!/overview?namespace=go-api-boilerplate

Domain

Dispatching command

Send example JSON via POST request

curl -sSL -D -d '{"email":"[email protected]"}' -H "Content-Type: application/json" -X POST https://go-api-boilerplate.local/users/v1/dispatch/register-user-with-email -o /dev/null --insecure

View

Public routes

Get user details https://go-api-boilerplate.local/users/v1/34e7ed39-aa94-4ef2-9422-401bba9fc812

{"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812","email":"[email protected]"}

Get list of users https://go-api-boilerplate.local/users/v1?page=1&limit=10

{"page":1,"limit":20,"total":1,"users":[{"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812","email":"[email protected]"}]}

Protected routes

Access protected route using auth token https://go-api-boilerplate.local/users/v1/me.

{"code": "401","message": "Unauthorized"}

Request access token for user

curl -sSL -D -d '{"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812"}' -H "Content-Type: application/json" -X POST https://go-api-boilerplate.local/users/v1/dispatch/request-user-access-token -o /dev/null --insecure

Get your access token from user pod event handler logs.

Access protected route using auth token https://go-api-boilerplate.local/users/v1/me?authToken=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJyXHUwMDE277-977-977-977-9IiwiZXhwIjoxNTU5NjEwOTc2LCJzdWIiOiIzNGU3ZWQzOS1hYTk0LTRlZjItOTQyMi00MDFiYmE5ZmM4MTIifQ.pEkgtDAvNh2D3Dtgfpu4tt-Atn1h6QwMkDhz4KpgFxNX8jE7fQH00J6K5V7CV063pigxWhOMMTRLmQdhzhajzQ

{"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812","email":"[email protected]"}

Sponsoring

🚀 Contributing

Want to contribute ? Feel free to send pull requests!

Have problems, bugs, feature ideas? We are using the github issue tracker to manage them.

👨🏻‍💻👩🏾‍💻 Core Team:

Rafał Lorenz

👥 Backers

Support us with a monthly donation and help us continue our activities.

🥇 Sponsors

Proudly sponsored by Open Collective sponsors.

• 👥 Contribute on Open Collective

License