🐳 Golang template

Golang template that includes the following features:

📚 Features

• ✅ Pre-commit
• ✅ CodeQL
• ✅ Sentry
• ✅ Docker
• ✅ Terraform
• ✅ Kubernetes
• ✅ GitHub Actions
• ✅ CHANGELOG
• ✅ Makefile
• ✅ CONTRIBUTE.md

🧰 Requirements

• Golang >= 1.23
• Docker (optional)

💾 Instalation

To install the project, run the following command:

git clone /~https://github.com/jd-apprentice/jd-golang.git
cd jd-golang
cp .env.example .env
make dev

Make sure to complete the .env file with the following information:

Variable	Description
SENTRY_DSN	The Sentry DSN

Change the default names with the following script:

mak replace     
$ bash ./scripts/app_name.sh
Enter the new name: sample
Replacement completed. 🚀

This will replace all app_name with sample in the project.

Run with Golang

make

This will build the app with golang and execute the binary.

Run with Docker 🐳

1. Build the image manually

Remember to replace app_name with the name of your app.

docker build -f docker/base-x86_64.Dockerfile -t app_bin .
docker build -f docker/app.Dockerfile -t app_name .
make compose-up

🤝 Contribute

• For more information, check the CONTRIBUTE file

✨ Contributors

Thanks goes to these wonderful people (emoji key):

Jonathan Dyallo 💻 ⚠️ 📖 🚧