Home

Welcome to the typical-go-server wiki!

The project aims to provide typical RESTful API Server for Go.

• Simple: Encourage KISS Principle with go idiomatic code and conventions.
• Scalable: Ready for Distributed System and Micro Service Architecture.
• Self Explanatory Project: Make sure everyone easy to understand and on board to the project

Checklist

• Encourage KISS Principle
  • Go Idiomatic
  • Rails-like Project Layout
  • Separation of concerns
  • Dependency Injection
• System Scalability
  • Follow 12 Factor App
  • Environment Variable as configuration (for development, use direnv)
  • Package Management/Vendoring
  • Graceful Shutdown
  • Health Check
• Self-explanatory Project
  • Self Testing Code
  • Project README
  • Automatically generate cli/command documentation
  • Automatically generate config documentation
  • Makefile
  • GoDoc
  • Wiki
• RESTful API
  • CRUD Operation
  • Model Validation
  • Authentication
  • CORS
  • Cache
  • Pagination
  • Search API
  • API Versioning
  • API Documentation
• Working with Database
  • Postgres Database
  • Data Access Layer/Repository Pattern
  • Test database
  • Soft delete
  • Database Administration
    • Create db
    • Drop db
    • Migration
    • Rollback
• Worker
  • Job Background Process
• Internationalization
• Misc
  • Debug/Profiling
  • Travis CI example
  • Docker example

Misc

• Library Overview
• Similar Projects