https://github.com/k-yomo/go_echo_api_boilerplate

Go api boilerplate built with echo
https://github.com/k-yomo/go_echo_api_boilerplate

api echo gke jwt swagger

Last synced: 2 months ago
JSON representation

Go api boilerplate built with echo

• Host: GitHub
• URL: https://github.com/k-yomo/go_echo_api_boilerplate
• Owner: k-yomo
• License: mit
• Created: 2019-07-21T18:46:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-08-20T22:35:11.000Z (over 5 years ago)
• Last Synced: 2024-06-20T10:19:16.979Z (7 months ago)
• Topics: api, echo, gke, jwt, swagger
• Language: Go
• Homepage:
• Size: 109 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Go API boilerplate built with echo framework

[![CircleCI](https://circleci.com/gh/k-yomo/go_echo_api_boilerplate.svg?style=svg)](https://circleci.com/gh/k-yomo/go_echo_api_boilerplate)

[![codecov](https://codecov.io/gh/k-yomo/go_echo_api_boilerplate/branch/master/graph/badge.svg?token=cGgCiXQXVc)](https://codecov.io/gh/k-yomo/go_echo_api_boilerplate)

## 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

```

2. Create `.env` file in reference to .env.sample

3. Install dependent modules

```

go mod install

```

4. 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

```

2. Create `.env` file in reference to .env.sample

3. 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](./cmd/db)

## Deployment(WIP)