go-standard

A clean architecture of go project to be used as a template for next development in go.

Prerequisite

1. Install golang
2. Install dep from github.com/golang/dep

How to use this project to create a new project

1. go get -u github.com/mokapos/go-standard
2. cd $GOPATH/src/github.com/mokapos/go-standard
3. rm -rf .git
4. Use this project to init your new project to git.
5. Delete this project folder in your local machine.
6. DO NOT USE git clone, use go get -u github.com/{your git account}/{your new project} instead!
7. cd $GOPATH/src/github.com/{your git account}/{your new project}
8. Enjoy!

References

General Guidance and Convention

• Official Golang CodeReviewComments
• Effective Go
• What's in a name by Andrew Gerrand

Project Structure

• Structuring Application by Ben Jhonson

Design Pattern

• Mencoba Clean Architecture pada golang Oleh Iman Tumorang
• Clean Architecture by Uncle Bob

Table Of Contents

1. Naming Convention
2. Comment
3. Database
4. Error Handling
5. Imports
6. Project Structure
7. Packaging
8. Development Environment

1. Naming Convention

For naming convention, golint (https://github.com/golang/lint) will provide the analysis. Then, the code must be cleaned by gofmt and goimports. Last, make sure the source code is already analyzed by govet before committing.

2. Comment

go provides C-style block comments (/* */) and line comments (// here lies the comment). Every package in go must have a package comments which defined preceeding the package clause.

/*
Package postgresql will implement Repository interface which will be interact
with database connection to create / read / update / delete data from database.

No business logic will be handled in this level, business logic will be handled
in interactor / usecase level.
*/
package postgresql

type UserRepository struct { ... }

func (ur *UserRepository) GetServices() ([]*Service, error) { ... }
func (ur *UserRepository) GetServiceByID(id uint64) (*Service, error) { ... }

Comments for declaration variable / struct / constant / interface must be defined in full sentence. Comments must begin with the "thing" being described and end with a period. Ex.

// GroupRepository will used as interface to be implemented in repository level.
type GroupRepository interface { ... }

// Lower will set text value to lowercase - will return error when conversion failed.
func Lower(text string) (string, error) { ... }