# README
Golang Echo Template
This is a simple golang echo template that implement golang template project structure
Getting Started
- Use this template to create a new project
- Modify rename-module.sh (or rename-module.ps1) variable to match your project name
- Run
rename-module.sh
orrename-module.ps1
- Copy .env.example and fill in your environment variables
Running
- Install dependency with
go mod download
- Run
make serve
to start server
Alternatively, you can run through docker just by running
docker compose up -d
Migration
Migration handled using golang-migrate. You need to install it if not using docker Migration automatically run everytime docker container start
- To apply migration, run
make migrate
- To create migration, run
make migration name=migration_name
- To rollback migration, run
make rollback name=migration_name
Progress
Name | Status |
---|---|
Core | 🚧 |
Unit Test | 🚧 |
Docker | ✔️ |
Migration | ✔️ |
API Documentation | 🚧 |
Auto handle role & permission | ❌ |
Github Workflow | ❌ |
If you want to contribute, feel free to open pull request