service

README

🧩 Service

Template for a typical service written on Go.

🛫 Quick start

Work with Makefile

$ make setup
$ make help

$ make find-todos
$ make test lint
$ TIMEOUT=5s make test-with-coverage

Work with Taskfile

$ alias run=./Taskfile
$ run refresh
$ run help

$ run docs # === `run docs install -- build -- start`
$ run docs npm ci
$ run docs npm i nextra@latest

$ run tools go generate tools.go
$ run tools golangci-lint --version -- mockgen --version
$ run which goimports golangci-lint govulncheck mockgen

Work with Tools

$ make tools
$ source bin/activate

$ which goimports
$ goimports -local $(go list -m) -w ./...

Work with Docker

$ make go-1.19 # or go-1.20, etc.
/src# make go-env 2>/dev/null | grep GOVERSION
# GOVERSION:   1.19.10
/src# make test

💡 Idea

Define a powerful template that quickly creates a new Go service. Not only does it provide a starting point for new projects, but it comes equipped with pre-configured ci/cd and inventory.

$ server up &
$ client call

🏆 Motivation

At OctoLab, we want to start new projects faster using best practices with a predefined structure and focusing on core ideas implementation rather than wasting time on environment configuration and copying boilerplate code.

🤼‍ How to

Build your own service

1. Generate a new repository from the template.
2. Clone the repository locally.
3. Update the desired files as needed, e.g., run init my.new/service.
4. Write your code and tests.
5. 🚀

Contribute to the template

1. Read the contribution guidelines.
2. Fork the repository.
3. Make your changes.
4. Send a pull request.
5. 🤗

Before you start, please make sure your changes are in demand. The best for that is to create a new discussion, or if you find an issue, report it first.

🎛️ Configuration

Pre-configured

1. GitHub Actions.
2. GitHub Pages.
3. Dependabot.

Included

1. Nextra.
2. Makefiles.
3. Taskfiles.
4. Go tools:
   • mockgen
   • goimports
   • golangci-lint
   • govulncheck
   • goreleaser
   • godownloader
   • protobuf
   • buf
   • grpc
   • grpc-gateway
   • twirp

Optional

1. Bitbucket[^1].
2. Codecov.
3. Slack.
4. Settings[^2].
5. Go Report Card.
6. Shields.io.
7. GitHub Socialify.

[^1]: An alternative for backup could be GitLab, Gogs, or Gitea.

[^2]: It has been deprecated and will be replaced someday by GitHub Actions.

Coming soon

1. Cloudflare Pages (docs hosting).
2. CodeQL (code scanning).
3. Graphite (git workflow).
4. Qodana (code quality).
5. SonarCloud (code quality).
6. Vanity URL (canonical import path).
7. Vercel (docs hosting).

🛬 Installation

Homebrew

$ brew install octolab/tap/service

Binary

$ curl -fsSL https://install.octolab.org/octomation/service | sh
# or
$ wget -qO-  https://install.octolab.org/octomation/service | sh

Source

# use standard go tools
$ go get go.octolab.org/template/service/cmd/client@latest
$ go get go.octolab.org/template/service/cmd/server@latest
# or use egg tool
$ egg tools add go.octolab.org/template/service/cmd/client@latest
$ egg tools add go.octolab.org/template/service/cmd/server@latest

Shell completions

$ client completion > /path/to/completions/...
# or
$ source <(client completion)

🏗️ Ecosystem

Input

• https://github.com/octomation/go-tool
• https://github.com/octopot/forma
• https://github.com/octopot/guard
• https://github.com/octopot/octopus
• https://github.com/octopot/passport
• https://github.com/octopot/tablo

Impact

• https://github.com/octomation/app
• https://github.com/octomation/install
• https://github.com/octomation/maintainer
• https://github.com/octomation/makefiles
• https://github.com/octomation/taskfiles
• https://github.com/octomation/vanity

Output

• https://github.com/withsparkle/service

made with ❤️ for everyone by OctoLab

Documentation

Index

• Variables

Variables

var License []byte