https://github.com/tupizz/go-rest-api

https://github.com/tupizz/go-rest-api

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tupizz/go-rest-api
• Owner: tupizz
• License: mit
• Created: 2020-05-07T14:27:59.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-05-08T19:08:36.000Z (about 5 years ago)
• Last Synced: 2025-02-09T14:47:28.953Z (4 months ago)
• Language: Go
• Size: 87.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Golang Example Boilerplate

[![lint](https://github.com/saefullohmaslul/golang-example/workflows/lint/badge.svg?branch=master)](https://github.com/saefullohmaslul/golang-example/actions?query=workflow%3Alint) [![test](https://github.com/saefullohmaslul/golang-example/workflows/test/badge.svg?branch=master)](https://github.com/saefullohmaslul/golang-example/actions?query=workflow%3Atest) [![codecov](https://codecov.io/gh/saefullohmaslul/golang-example/branch/master/graph/badge.svg)](https://codecov.io/gh/saefullohmaslul/Golang-Example/tree/master/src) [![Go Report Card](https://goreportcard.com/badge/github.com/saefullohmaslul/golang-example)](https://goreportcard.com/report/github.com/saefullohmaslul/golang-example) [![build](https://github.com/saefullohmaslul/golang-example/workflows/build/badge.svg?branch=master)](https://github.com/saefullohmaslul/golang-example/actions?query=workflow%3Abuild)

Simple REST API with golang (**golang boilerplate**)

## How to run

There are two ways to run this application, with docker or without docker

```bash

# running with docker

# copy .env

cp .env.example .env

# running in development mode, you can use live-reload when safe file

make docker-dev

# running in production image

make docker-prod

docker logs --tail=100 -f golang_example_production # monitoring production container

docker exec -it golang_example_production sh # access bash on production container

```

```bash

# running in local/without docker

# copy .env

cp .env.example .env

make install

make run

```

## Run tests

```bash

make test

```

## Stay in touch

* Author - [Saefulloh Maslul](https://linkedin.com/saefullohmaslul)

## License

Golang-Example is [MIT](LICENSE).