go_echo_api_boilerplate

Go API boilerplate built with echo framework

Getting Started

Prerequisites

• Go 1.12 (skip if you use docker)
• MySQL 5.7 (skip if you use docker)
• direnv

External Service

• Twilio (for SMS authentication)
• SendGrid (for sending email)

Usage

1. Clone repo

git clone https://github.com/k-yomo/go_echo_api_boilerplate.git
cd go_echo_api_boilerplate

1. Create .env file in reference to .env.sample

2. Install dependent modules

go mod install

1. Run dev server

// Listening on localhost:1323 with hot reloading(localhost:5002)
realize start --server

Usage with Docker

1. Clone repo

git clone https://github.com/k-yomo/go_echo_api_boilerplate.git
cd go_echo_api_boilerplate

1. Create .env file in reference to .env.sample

2. Run containers

// Listening on localhost:1323 with hot reloading(localhost:5002)
docker-compose up -d

Running the tests

make test

with coverage

make cover

API Docs

1. Run dev server
2. Open localhost:1323/swagger/index.html

Migration

• See cmd/db/migrate

Deployment(WIP)