Highly opinionated Go service. 🐻
This is a complete over-engineered Golang service template, which strongly relies on the building blocks of my (also) highly opinionated Go backend kit.
This template is already being used by some companies on production, handling non-trivial volumes of traffic. However, use it at your own "risk", this is a personal project and support is not the main intention.
This repository packs so many features that I am unable to sit down and list them all : ). Feel free to take a look at the code.
Make a copy of envs/dev/.env.example to envs/dev/.env and fill the variables. envs/dev/.env is an ignored file so you won't have the chance to commit it with potential production values 😉.
Also, to setup the environment, follow these steps:
- Install dependencies:
pip install -r scripts/requirements.txt - Install tools
inv tool.install --include "dev*"
Run inv help for further commands and inv <command> --help for their usage.
To make this environment work you will have to make the following changes:
-
Make a copy of
envs/prod/.env.exampletoenvs/prod/.env(which is ignored) and fill the variables. -
Create 2 Cloudflare Tunnels, one for exterior user accessible services
ext, and the other for interior company-only accessible services and toolsint. -
Download both Tunnels certificates to
envs/prod/certs/(which is ignored). -
Fill both Tunnels configuration files
envs/prod/cloudflared-ext.yaml & cloudflared-int.yamlwith the Tunnel ID and credentials path. -
Change the
scripts/tasks.pybuild & deploytasks to tag and push your service images to your registry of preference (it should be a private registry...).
- Finally, fill the
envs/prod/docker-compose.yamlso the service containers point to your own registry images.
Feel free to contribute to this project : ) .
This project is licensed under the MIT License - read the LICENSE file for details.