go-boilerplate

go-boilerplate

A go boilerplate with docker-compose with hot reload, postgres, orm, github templates, license...

Setup

Modify the docker/go/Dockerfile file and set the following line with the correct repository name :

WORKDIR /go/src/github.com/edwinvautier/go-bot

Do the same in the docker-compose.yml inside the api volumes part.

Project setup

Generate RSA keys for the token authentication :

    # use the following password: private_key
    openssl genrsa -des3 -out private.pem 2048
    openssl rsa -in private.pem -outform PEM -pubout -out public.pem

Update your environment. Create a .env file thanks to the .env.dist example.

build app :

    docker-compose up --build

Branch naming convention

You branch should have a name that reflects it's purpose.

It should use the same guidelines as COMMIT_CONVENTIONS (feat, fix, build, perf, docs), followed by an underscore (_) and a very quick summary of the subject in kebab case.

Example: feat_add-image-tag-database-relation.

Pull requests (PR)

Pull requests in this project follow two conventions, you will need to use the templates available in the ISSUE_TEMPLATE folder :

• Adding a new feature should use the FEATURE_REQUEST template.
• Reporting a bug should use the BUG_REPORT template.

If your pull request is still work in progress, please add "WIP: " (Work In Progress) in front of the title, therefor you inform the maintainers that your work is not done, and we can't merge it.

The naming of the PR should follow the same rules as the COMMIT_CONVENTIONS

Linter

We use go linter gofmt to automatically formats the source code.