hexagony icon indicating copy to clipboard operation
hexagony copied to clipboard

Clean architecture example in Golang.

build Coverage Status Go Report Card GitHub license

Hexagony name was taken from one of the Hate's songs. Hate is a death metal band from Poland.

Running

First rename the .env_example file to .env and fill the variables if you want.

Next, make sure you have Docker and Docker Compose installed and then run the following command:

$ docker-compose up --build

Or in Detached Mode:

$ docker-compose up -d --build

Then, check the app up and running: http://localhost:8000.

There's a online version running on Heroku: https://hexagony.herokuapp.com/

Documentation

Access: http://localhost:8000/docs/index.html

Generate doc:

$ swag init -g ./cmd/server/main.go

Schema

Download the schema inside docs folder and import in your Insomnia application or another request tool. You need to specify Authorization header along with the Bearer token.

Generate Token

Use the following credentials:

User: [email protected]

Pass: 12345678

Front-End Application

Check the Hexagony front-end: https://github.com/williamscalado/hexagony-front-react

There's a online version running on Vercel: https://hexagony.vercel.app