safe-as-houses

README

safe-as-houses

Project Background and Motivation

Welcome 👋

This is a personal project to explore a few new technologies, particularly the Go programming language.

Shout out to this cracking Udemy Course for the inspiration!

🚧 Disclaimer 🚧

This is a work in progress 🏗️ and as such could be in an 'interim state' without notice.

Deployment

I am currently deploying service to AWS EKS via Github actions workflow.

api swagger docs can be found here

• I have deleted the AWS infrastructure to save money 🏦.
• An EKS cluster is a solid choice IMHO for a production setup but the daily cost of just running this demo isn't worth it 💸.
• When I get a chance, I will get it deployed onto a cheaper setup for demo 👍.

Local Development

Prerequisite tooling

• Docker Desktop
  • Note: launching Docker Desktop starts the Docker daemon (Green whale in bottom left = running)
• Golang
• Migrate
• sqlc
• gomock
• dbdocs
• dbml cli
• evans grpc client

Starting service

The service can be run locally either using

• Docker compose

# in project root directory run:
docker compose up

• OR using utilities in Makefile.

Notes

K8s installation notes