# Micro Starter Kit

Microservices starter kit for **Golang**, aims to be developer friendly.

[![GoDoc](https://godoc.org/github.com/xmlking/micro-starter-kit?status.svg)](https://godoc.org/github.com/xmlking/micro-starter-kit) [![Go](https://img.shields.io/github/go-mod/go-version/xmlking/micro-starter-kit/develop)](https://golang.org/dl/) [![Renovate dependency Status](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/) [![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)

### Build Status

[![Build Status](https://github.com/xmlking/micro-starter-kit/workflows/Test%20on%20Push/badge.svg?branch=develop)](https://github.com/xmlking/micro-starter-kit/actions?query=branch%3Adevelop+event%3Apush+workflow%3A%22Test+on+Push%22)

### Quality

[![Go Report Card](https://goreportcard.com/badge/github.com/xmlking/micro-starter-kit)](https://goreportcard.com/report/github.com/xmlking/micro-starter-kit) [![Total alerts](https://img.shields.io/lgtm/alerts/g/xmlking/micro-starter-kit.svg?logo=lgtm\&logoWidth=18)](https://lgtm.com/projects/g/xmlking/micro-starter-kit/alerts/) [![codecov](https://codecov.io/gh/xmlking/micro-starter-kit/branch/develop/graph/badge.svg)](https://codecov.io/gh/xmlking/micro-starter-kit) [![Language grade: Go](https://img.shields.io/lgtm/grade/go/g/xmlking/micro-starter-kit.svg?logo=lgtm\&logoWidth=18)](https://lgtm.com/projects/g/xmlking/micro-starter-kit/context:go) [![fuzzit](https://app.fuzzit.dev/badge?org_id=xmlkinggithub\&branch=develop)](https://app.fuzzit.dev/orgs/xmlkinggithub/dashboard)

## Overview

![Image of Deployment](https://1047947560-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lz41-cyceJsyfV6tch6%2F-Lz41gqjpeaBWzjl64Qj%2F-Lz41pbUiY1T7D6kOPQ_%2Fdeployment.png?generation=1579558854121238\&alt=media)

### What you get

* [x] Monorepo - Sharing Code Between Microservices
* [x] gRPC microservices with REST Gateway
* [x] Input Validation with [protoc-gen-validate (PGV)](https://github.com/envoyproxy/protoc-gen-validate)
* [x] Config - Pluggable Sources, Mergeable Config, Safe Recovery
* [x] Customizable Logging
* [x] CRUD Example using [GORM](https://gorm.io/), [benchmarks](https://github.com/kihamo/orm-benchmark), [XORM](https://xorm.io/) next?
* [x] GORM code gen via [protoc-gen-gorm](https://github.com/infobloxopen/protoc-gen-gorm) or use [protoc-go-inject-tag](https://github.com/favadi/protoc-go-inject-tag)?
* [x] Dependency injection [Container](https://github.com/sarulabs/di), Try [wire](https://itnext.io/mastering-wire-f1226717bbac) next?
* [x] multi-stage-multi-target Dockerfile
* [x] One Step *build/publish/deploy* with [ko](https://github.com/google/ko)
* [x] BuildInfo with [govvv](https://github.com/ahmetb/govvv)
* [x] Linting with [GolangCI](https://github.com/golangci/golangci-lint) linters aggregator
* [x] Linting Protos with [Buf](https://buf.build/docs/introduction)
* [x] CICD Pipelines with [GitHub Actions](https://github.com/features/actions)
* [x] Kubernetes *Matrix Deployment* with [Kustomize](https://kustomize.io/)
* [ ] Add k8s [healthchecks](https://github.com/heptiolabs/healthcheck) with [cmux](https://medium.com/@drgarcia1986/listen-grpc-and-http-requests-on-the-same-port-263c40cb45ff)
* [x] Feature Flags (enable/disable with zero cost)
* [ ] Observability
* [ ] Service Mesh with [Istio](https://istio.io/)
* [ ] GraphQL Gateway with [gqlgen](https://gqlgen.com/), [rejoiner](https://github.com/google/rejoiner),[gqlgen](https://github.com/Shpota/skmz)
* [ ] Graph-Based ORM [ent](https://entgo.io/)
* [ ] Switch to [Bazel Build](https://bazel.build/)

## Getting Started

### Prerequisite

Refer [prerequisites](https://xmlking.gitbook.io/micro/develop/getting-started/prerequisites) docs

### Initial Setup

Also Refer [scaffolding](https://github.com/xmlking/micro-starter-kit/tree/d2f084ea68647844c3e1a204369fd379d99b410c/docs/introduction/scaffolding.md) docs

> clone the repo

```bash
git clone https://github.com/xmlking/micro-starter-kit ~/Developer/Work/go/micro-starter-kit
# pull dependencies (when every time `go.mod` changed)
go mod download
```

### Run

#### Database

By default this project use embedded `sqlite3` database. if you want to use **postgreSQL**,

* start **postgres** via `docker-compose` command provided below
* uncommend `postgres` import statement and comment `sqlite` in `plugin.go`
* start micro server with `--configFile=config.dev.postgres.yaml` flag <br>

  i.e., `go run srv/account/main.go srv/account/plugin.go --configFile=config.dev.postgres.yaml`

```bash
# to start postgres in foreground
docker-compose up postgres
# to stop postgres
docker-compose down
# if needed, remove `postgres_data` volume to recreate database next time, when you start.
docker system prune --volumes
```

#### Services

> Node: `--server_address=localhost:5501x --broker_address=localhost:5502x` required only when you are behind VPN a.k.a `Work From Home`

```bash
# dev mode
make run-account
# or
make run-account ARGS="--server_address=localhost:55011 --broker_address=localhost:55021"
# or
go run srv/account/main.go srv/account/plugin.go \
--configDir deploy/bases/account-srv/config \
--server_address=localhost:55011 --broker_address=localhost:55021

make run-greeter
# or
make run-emailer ARGS="--server_address=localhost:55012 --broker_address=localhost:55022"

make run-emailer
# or
make run-emailer ARGS="--server_address=localhost:55013 --broker_address=localhost:55023"


# integration tests for config module via CMD
make run TARGET=demo TYPE=cmd
go run cmd/demo/main.go --help
go run cmd/demo/main.go --database_host=1.1.1.1 --database_port=7777

export APP_ENV=production
go run cmd/demo/main.go
```

### Test

Refer [testing](https://xmlking.gitbook.io/micro/develop/testing/testing) docs

## GitOps

### Make

Refer [makefile](https://xmlking.gitbook.io/micro/develop/getting-started/makefile) docs

### Docker

Refer [docker](https://xmlking.gitbook.io/micro/develop/devops/docker) docs

### Release

Refer [releasing](https://github.com/xmlking/micro-starter-kit/tree/d2f084ea68647844c3e1a204369fd379d99b410c/docs/concepts/releasing.md) docs

### Deploy

```bash
make docker DOCKER_REGISTRY=docker.pkg.github.com DOCKER_CONTEXT_PATH=xmlking/micro-starter-kit
docker rmi $(docker images -f "dangling=true" -q)

# make kustomize OVERLAY=e2e NS=default VERSION=v0.1.0-440-g6c7fb7a
make kustomize
kubectl apply -f build/kubernetes.yaml

POD_NAME=$(kubectl get pods  -lapp.kubernetes.io/name=account-srv -o jsonpath='{.items[0].metadata.name}')
kubectl logs -f -c srv $POD_NAME

kubectl delete -f build/kubernetes.yaml
```

## Reference

### Project Docs

1. [prerequisites](https://xmlking.gitbook.io/micro/develop/getting-started/prerequisites)
2. [scaffolding](https://github.com/xmlking/micro-starter-kit/tree/d2f084ea68647844c3e1a204369fd379d99b410c/docs/introduction/scaffolding.md)
3. [makefile](https://xmlking.gitbook.io/micro/develop/getting-started/makefile)
4. [testing](https://xmlking.gitbook.io/micro/develop/testing/testing)
5. [docker](https://xmlking.gitbook.io/micro/develop/devops/docker)
6. [gitops](https://xmlking.gitbook.io/micro/develop/advanced/gitops)
7. [Protobuf Style Guide](https://buf.build/docs/style-guide)
8. [Google Protobuf Style Guide](https://github.com/uber-go/guide/blob/master/style.md)

### External Docs

1. [Go-Micro Getting Started](https://itnext.io/micro-in-action-getting-started-a79916ae3cac)
2. [examples](https://github.com/micro/examples) - example usage code for micro
3. [microhq](https://github.com/microhq) - a place for prebuilt microservices
4. [explorer](https://micro.mu/explore/) - which aggregates micro based open source projects
5. [micro-plugins](https://github.com/micro/go-plugins) extensible micro plugins
6. [step-by-step-guide-micro](https://github.com/micro-in-cn/tutorials/tree/master/microservice-in-micro)
7. [micro-in-cn](https://github.com/micro-in-cn/tutorials/tree/master/examples)
8. [Platform Web](https://github.com/micro-in-cn/platform-web)
9. [grpc template](https://github.com/vtolstov/micro-template-grpc)
10. [Simple API backed by PostgresQL, Golang and gRPC](https://medium.com/@vptech/complexity-is-the-bane-of-every-software-engineer-e2878d0ad45a)