My Personal Template for Go

Don't use it for production!

Clone the project

$ git clone https://github.com/stonear/go-template
$ cd go-template

REST Resource Naming Guide

Verb	URI	Action
GET	/entities	Index
GET	/entities/create	Create (Not implemented)
POST	/entities	Store
GET	/entities/:id	Show
GET	/entities/:id/edit	Edit (Not implemented)
PUT	/entities/:id	Update
DELETE	/entities/:id	Destroy

Commit Naming Rules

A typical git commit message will look like: <type>: <subject>, "type" must be one of the following mentioned below:

• build: Build related changes
• chore: A code change that external user won't see (eg: change to .gitignore file or .prettierrc file)
• feat: A new feature
• fix: A bug fix
• docs: Documentation related changes
• refactor: A code that neither fix bug nor adds a feature. (eg: You can use this when there is semantic changes like renaming a variable/ function name)
• perf: A code that improves performance
• style: A code that is related to styling
• test: Adding new test or making changes to existing test

Testing

If you are using VSCode, I recommend you to use REST Client Extension for running apitest.http.

To check if the database connected successfully, you can run the following command:

go test -timeout 30s -run ^TestDb$ github.com/stonear/go-template/database

Files with the suffix _test.go are only compiled and run by the go test tool.