Skip to content

Latest commit

 

History

History
62 lines (53 loc) · 2.93 KB

README.md

File metadata and controls

62 lines (53 loc) · 2.93 KB
Raw

Anne Bonny

A template to bootstraping microservices with go.

Also helps to fight global warming acting as Anne Bonny.

Testing

Please, provide env vars for testing in a file called testing.env at repo root folder level. See the Workspace declaration to infer the testing usage.

TODOS

  • [] History service with indirect communication with the video-streamer service. Use rabbit.
  • [] Tutorial
  • Add Database to a single service
  • Use squirrel to build SQL statements
  • [] Healthcheck in dockerfile
  • Use echo+Validator to validate request data
  • [] Add a front client (use flutter?)
  • [] Swagger auto generation
  • [] Add a public golang sdk api client for the exposed API.
  • [] Add a private golang sdk api client for both the exposed and the internal services API.
  • Add hot reloading to docker-compose
  • [] Add redis and a cache example.
  • [] Deployer
  • [] IaC
  • [] KrakenD : It will coexist with caddy? Caddy will do the krakenD task for no local overcharging?
  • [] Jaeaguer
  • [] Kubernetes
  • [] Local CI/CD tool with Jenkins or GitLabCI
  • [] Configure caddy and localhost to generate local certificates for *.annebonny.dev and serve they as in this tutorial
  • Add migrations with goose
  • [] Add ghost as a blog for Anne Bonny
  • [] Check golang generics in order to know if you can add the factory injection in maryread.
  • [] Concurrency example
  • [] Cronjobs. Create a new user service and allow to create temp users (6 hours, 3 days, 1 week).
  • Use release-it to app version management.
  • [] GRPC. Let maryread start in grcp mode?
  • [] Websockets example.
  • [] Integration tests using the sdk.
  • [] Basic SQL test data seeder per service
  • [] Use the client to seed the application with test data
  • [] Add Benchmark tests.
  • [] Add to the client mock responses. At now, to test the video handler, you must up and expose the storage service
  • [] Find a way to load non tracked .env files to the makefile.
  • [] Install goose in the dev Dockerfile target and provide a make command per service to execute migrations from the running container. This way, you will not install goose in the host.
  • [] Recovery system. Store all CUD events in the system in a mongo collection. Provide a way to restore it to each microservice...

Tutorial

You must have both a "testing.env" file and a "override.env" file in the root of the project in order to invoque the make commands.

  • General Env Vars
  • Repos Env Vars
  • Running locally
  • Running test -- Running all test in vs -- Debugging test in vs code -- Generate a test report and review it in a browse.
  • Deploying
  • Tools
  • direnv to load .envrc (simplify your life testing migrations, for example).