The document proposes a template called Template7 to help with common decisions in building software projects, such as data types, errors, architecture, and documentation. It describes Template7's overall and backend architectures, including layers like API, middleware, handlers, and components. The template also includes suggestions for patterns like singletons, custom data types, and errors to standardize code across projects.

1. Let’s Template
Allen Kao

2. Allen Kao
- Senior Backend Engineer @ ROEHL
- kaodondon7@gmail.com

3. Side Project / Product: Template7

4. Motivation
● camelCase, snake_case or others?
● http, Http or HTTP ?
● documentation ?
● code architecture ?

5. Motivation
● db client ? logger ? error ?
● auth ? oauth2 ? jwt ?
● CICD ?

6. Motivation

7. No idea ? why not just template ?

8. Step1: User
● Over 90% products have “user”

9. Step2: Make some REST API whatever you want

10. StepN: Keep update once you learned something cool !

11. Template7 Overall Architecture

12. Template7 Backend Architecture
Layer Function
API / Route Registered API endpoint.
Middle ware Common / routine functions such like token
verification, body check, etc.
Handler Parse necessary variables from URI or body.
Component Core business logic, include third-party client.
DB Client DB manipulation functions.
Redis Client Redis client.
Document / Struct Definition of DB documents / structs, it could be
referenced by any layer.

13. Template7 CLI-Tool Architecture
Layer Function
APP CLI entry.
Command & Flags Define each command and its flags.
Component Core business logic, include third-party
client.
DB Client DB manipulation functions.
Backend Client Client to access backend API.
Document / Struct Definition of DB documents / structs, it
could be referenced by any layer.

14. Documentation

15. Swagger

16. Swagger
● Annotation as document
● Ref: https://github.com/swaggo/swag
● Generate docs.go

17. Frequently Patterns

18. Singleton
Ref: https://en.wikipedia.org/wiki/Singleton_pattern

19. Singleton
● xClient
○ dbClient
○ logisticClient
○ googleClient
○ fbClient
○ …
● Do once only
○ Read config
○ Read template
● Exactly one instance during the whole
system lifecycle
● Should not include any argument such
like New(env string)

20. Custom Data Type
●

21. Custom Data Type
● Concept: custom fundamental data type for chosen field.
Field Suggestion
gender V
type V
status V
name X
order id X
level ?

22. Custom Error

23. Custom Error

24. Shared Lib

25. Shared Lib
Public Repo:
go.mod:
Private Repo:
go.mod:
Shell:
git config --global
url."https://$GIT_TOKEN@github.com".insteadOf
"https://github.com"

26. CI (Continuous Integration)

27. Github actions
● Routine workflow right after code changed (push, merge, commit, etc.)
● Tons of ready-made templates that are free: https://github.com/actions

28. Deployment

29. Kubernetes Architecture

30. Helm
Template:
Value:
kubectl

31. Helm I have a template
I have a value
Deployment
Ugh!