Popularity
6.1
Growing
Activity
9.0
Declining
278
15
46

Description

Golang API Starter Kit ================ [![Build Status](https://travis-ci.org/vardius/go-api-boilerplate.svg?branch=master)](https://travis-ci.org/vardius/go-api-boilerplate) [![Go Report Card](https://goreportcard.com/badge/github.com/vardius/go-api-boilerplate)](https://goreportcard.com/report/github.com/vardius/go-api-boilerplate) [![codecov](https://codecov.io/gh/vardius/go-api-boilerplate/branch/master/graph/badge.svg)](https://codecov.io/gh/vardius/go-api-boilerplate) [![](https://godoc.org/github.com/vardius/go-api-boilerplate?status.svg)](http://godoc.org/github.com/vardius/go-api-boilerplate) [![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/vardius/go-api-boilerplate/blob/master/LICENSE.md) [![baker](https://opencollective.com/go-api-boilerplate/tiers/backer/badge.svg?label=backer&color=brightgreen)](https://opencollective.com/go-api-boilerplate/contribute/backer-10349/checkout) [![sponsor](https://opencollective.com/go-api-boilerplate/tiers/sponsor/badge.svg?label=sponsor&color=brightgreen)](https://opencollective.com/go-api-boilerplate/contribute/sponsor-10350/checkout)

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

Table of Contents



- [About](#about) - [Documentation](#documentation) - [Example](#example) - [Quick start](#quick-start) - [Build release](#build-release) - [Deploy release](#build-release) - [Dashboard](#dashboard) - [Domain](#domain) - [Dispatching command](#dispatching-command) - [View](#view) - [Public routes](#public-routes) - [Protected routes](#protected-routes) - [Sponsoring](#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.

![Dashboard](../master/.github/kubernetes-dashboard-overview.png) ![Dashboard](../master/.github/kubernetes-dashboard-pods.png)

Key concepts: 1. Rest API 2. [Docker](https://www.docker.com/what-docker) 3. [Kubernetes](https://kubernetes.io/) 4. [Helm chart](https://helm.sh/) 5. [gRPC](https://grpc.io/docs/) 6. [Domain Driven Design](https://en.wikipedia.org/wiki/Domain-driven_design) (DDD) 7. [CQRS](https://martinfowler.com/bliki/CQRS.html) 8. [Event Sourcing](https://martinfowler.com/eaaDev/EventSourcing.html) 9. [Hexagonal, Onion, Clean Architecture](https://herbertograca.com/2017/11/16/explicit-architecture-01-ddd-hexagonal-onion-clean-cqrs-how-i-put-it-all-together/) 10. [oAuth2](https://github.com/go-oauth2/oauth2)

Worth getting to know packages used in this boilerplate: 1. [gorouter](https://github.com/vardius/gorouter) 2. [message-bus](https://github.com/vardius/message-bus) 3. [gollback](https://github.com/vardius/gollback) 4. [shutdown](https://github.com/vardius/shutdown) 5. [pubsub](https://github.com/vardius/pubsub)

DOCUMENTATION ==================================================

* [Wiki](https://github.com/vardius/go-api-boilerplate/wiki) * [Package level docs](https://godoc.org/github.com/vardius/go-api-boilerplate#pkg-subdirectories) * [Getting Started](https://github.com/vardius/go-api-boilerplate/wiki/1.-Getting-Started) * [Installing and Setting up](https://github.com/vardius/go-api-boilerplate/wiki/2.-Installing-and-Setting-up) * [Configuration](https://github.com/vardius/go-api-boilerplate/wiki/3.-Configuration) * [Guides](https://github.com/vardius/go-api-boilerplate/wiki/4.-Guides)

EXAMPLE ================================================== ## Quick start

### Build release ```sh make docker-build BIN=auth make docker-build BIN=migrate make docker-build BIN=user ``` ### Deploy release ```sh make helm-install ```

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

## Domain ### Dispatching command Send example JSON via POST request ```sh curl -sSL -D -d '{"email":"test@test.com"}' -H "Content-Type: application/json" -X POST https://go-api-boilerplate.local/users/dispatch/register-user-with-email -o /dev/null --insecure ``` ## View ### Public routes Get user details [https://go-api-boilerplate.local/users/34e7ed39-aa94-4ef2-9422-401bba9fc812](https://go-api-boilerplate.local/users/34e7ed39-aa94-4ef2-9422-401bba9fc812) ```json {"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812","email":"test@test.com"} ``` Get list of users [https://go-api-boilerplate.local/users?page=1&limit=10](https://go-api-boilerplate.local/users?page=1&limit=10) ```json {"page":1,"limit":20,"total":1,"users":[{"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812","email":"test@test.com"}]} ``` ### Protected routes Access protected route using auth token [https://go-api-boilerplate.local/users/me](https://go-api-boilerplate.local/users/me). ```json {"code": "401","message": "Unauthorized"} ``` Request access token for user ```sh curl -sSL -D -d '{"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812"}' -H "Content-Type: application/json" -X POST https://go-api-boilerplate.local/users/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/me?authToken=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJyXHUwMDE277-977-977-977-9IiwiZXhwIjoxNTU5NjEwOTc2LCJzdWIiOiIzNGU3ZWQzOS1hYTk0LTRlZjItOTQyMi00MDFiYmE5ZmM4MTIifQ.pEkgtDAvNh2D3Dtgfpu4tt-Atn1h6QwMkDhz4KpgFxNX8jE7fQH00J6K5V7CV063pigxWhOMMTRLmQdhzhajzQ](https://go-api-boilerplate.local/users/me?authToken=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJyXHUwMDE277-977-977-977-9IiwiZXhwIjoxNTU5NjEwOTc2LCJzdWIiOiIzNGU3ZWQzOS1hYTk0LTRlZjItOTQyMi00MDFiYmE5ZmM4MTIifQ.pEkgtDAvNh2D3Dtgfpu4tt-Atn1h6QwMkDhz4KpgFxNX8jE7fQH00J6K5V7CV063pigxWhOMMTRLmQdhzhajzQ) ```json {"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812","email":"test@test.com"} ```

Sponsoring ==================================================



## πŸš€ Contributing

Want to contribute ? Feel free to send pull requests!

Have problems, bugs, feature ideas? We are using the github [issue tracker](https://github.com/vardius/go-api-boilerplate/issues) 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](https://opencollective.com/go-api-boilerplate#sponsor).

- πŸ‘₯ [Contribute on Open Collective](https://opencollective.com/go-api-boilerplate#sponsor)

Programming language: Go
License: MIT License
Tags: Docker     Kubernetes     Server Applications     API     Web Frameworks     Webapp     gRPC     RPC     Http2     Boilerplate     Http     CQRS     DDD     Domain Driven Design     Event Sourcing     Helm     Bootstrap     oAuth2     Strater-kit    

Golang API Starter Kit alternatives and similar packages

Based on the "Server Applications" category

Do you think we are missing an alternative of Golang API Starter Kit or a related project?

Add another 'Server Applications' Package

README

🧰 Golang API Starter Kit

Build Status Test Go Report Card codecov license baker sponsor

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

Table of Contents

<!-- toc -->

πŸ“– ABOUT

The main purpose of this project is to provide boilerplate project setup 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.

Please look for comments like @TODO and @FIXME to better understand things than need attention.

Web UI example (React)

This boilerplate includes simple Web UI to demonstrate example interaction with API. Once deployed and hosts are set please visit https://api.go-api-boilerplate.local to access UI.

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. pushpull
  7. gocontainer
  8. ardanlabs/service

πŸ“š DOCUMENTATION

🏫 EXAMPLE

Quick start

Localhost alias

Edit /etc/hosts to add localhost alias

➜  go-api-boilerplate git:(master) cat /etc/hosts
##
# Host Database
#
# localhost is used to configure the loopback interface
# when the system is booting.  Do not change this entry.
##
127.0.0.1 go-api-boilerplate.local api.go-api-boilerplate.local maildev.go-api-boilerplate.local mysql.go-api-boilerplate.local

Build release

Local image

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

GitHub Package Registry

Creating tag with metadata will trigger github workflow and publish docker image to GitHub Package Registry.

Tag v1.0.0+user will trigger build for user service releasing 1.0.0 docker image tag. you can create release for all services in cmd directory.

v1.0.0+auth
v1.0.0+user
v1.0.0+web
v1.0.0+migrate

Replace image details in [values.yaml](helm/app/values.yaml)

  image:
-    repository: go-api-boilerplate-user
+    repository: docker.pkg.github.com/vardius/go-api-boilerplate/user
-    tag: latest
+    tag: 1.0.0
    pullPolicy: IfNotPresent

repeat for all services and migrate init containers.

Private Registry

If you want your k8sto Pull an Image from a Private Registry on your k8 machine login to docker:

docker login

Then create a secret in go-api-boilerplate namespace as follows:

kubectl create secret generic regcred --from-file=.dockerconfigjson=.docker/config.json --type=kubernetes.io/dockerconfigjson --namespace=go-api-boilerplate

Set imagePullSecrets in your [values.yaml](helm/app/values.yaml) file (simply look for all occurrences and uncomment).

+  imagePullSecrets: regcred

Install Cert Manager

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

make helm-dependencies

Deploy release

make helm-install

Domain

Dispatching command

Send example JSON via POST request

curl -d '{"email":"test@test.com"}' -H "Content-Type: application/json" -X POST https://api.go-api-boilerplate.local/users/v1/dispatch/register-user-with-email --insecure

View

Public routes

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

{"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812","email":"test@test.com"}

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

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

Protected routes

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

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

Request access token for user

curl -d '{"email":"test@test.com"}' -H "Content-Type: application/json" -X POST https://api.go-api-boilerplate.local/users/v1/dispatch/request-user-access-token --insecure

Get your access token from mail catcher https://maildev.go-api-boilerplate.local.

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

{"id":"34e7ed39-aa94-4ef2-9422-401bba9fc812","email":"test@test.com"}

πŸ’² 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 Marin Kirkov

πŸ‘₯ Backers

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

πŸ₯‡ Sponsors

Proudly sponsored by Open Collective sponsors.

πŸ“œ [License](LICENSE.md)


*Note that all licence references and agreements mentioned in the Golang API Starter Kit README section above are relevant to that project's source code only.