potato

This project is a Go skelethon to be used to develop new microservices. I'm still not sure what I'm gonna do with this in the future; the goal for now is to finish it and write down all the topics to be learn in order to understand what takes to build a Go microservice. Enjoy!

TODO

• 1. Receive an answer from an endpoint
• 2. Run tests locally
• 3. Run app locally
• 4. Submit aplication to container registry
• 5. Improve configuration
• 6. Create router
• 7. Expose CRUD endpoints
• 8. Certify server health
• 9. Get parameters from request
• 10. Isolate service logic
• 11. Store data
• 12. Enable admin permissions
• 13. Monitor requests
• ?. Prevent other services from explosion
• ?. Enable profiling
• ?. Improve response performance

Relevant topics

1. Receive an answer from an endpoint
   • Understanding the HTTP server implementation
2. Run tests locally
   • Table driven tests
   • httptest
   • Makefile
   • go mod
3. Run app locally
   • N/A
4. Deploy application
   • Container registry
   • GitHub Actions
   • Docker
   • YAML
   • lint
5. Improve configuration
   • Configuration files
   • Viper
   • YAML/TOML/JSON
   • flag package
6. Create router
   • Mux
   • Handler
   • Why and how to build a router
   • Obtain route variables
7. Expose CRUD endpoint
   • CRUD
   • Lock
   • HTTP methods, requests, responses
8. Certify server health
   • Healthcheck
9. Get parameters from request
   • Query params
10. Isolate service logic

• Interfaces
• Mocking

11. Store data

• Repository pattern
• Dependency injection
• KVS

12. Enable admin permissions

• Admin route
• Middlewares

13. Monitor requests

• Observability
  • Tracing
  • Logging
  • Metrics ?. Enable profiling
• pprof
• profiling ?. Implement an actual database ?. Improve response performance
• Cache ?. Authorization/Authentication ?. Stability patterns
• Context
• Circuit Breaker
• Debounce
• Retry
• Throttle
• Timeout
• Singleflight ?. Concurrency patterns
• Fan-In
• Fan-Out
• Future
• Sharding