https://github.com/ildarusmanov/gobase

This is a simple skeleton for golang application
https://github.com/ildarusmanov/gobase

github-template golang golang-examples skeleton-application

Last synced: about 1 month ago
JSON representation

This is a simple skeleton for golang application

• Host: GitHub
• URL: https://github.com/ildarusmanov/gobase
• Owner: ildarusmanov
• Created: 2019-01-23T21:40:50.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-12-15T16:58:16.000Z (about 4 years ago)
• Last Synced: 2023-03-27T17:03:59.763Z (almost 2 years ago)
• Topics: github-template, golang, golang-examples, skeleton-application
• Language: Go
• Homepage:
• Size: 12.1 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# GoBase

This is a simple skeleton for golang application. Inspired by development experience and updated according to github.com/golang-standards/project-layout.

## How to use?

1. Clone the repository (with git client `git clone github.com/ildarusmanov/gobase [project_name]` or use it as template on github for creating a new project)

2. replace `github.com/ildarusmanov/gobase` with `[your_pkg_name]` in the all files

## Structure

* /api - OpenAPI specs, documentation generated by swag

* /cmd - CLI

* /db - database migrations and seeds

* /docs - documentation

* /internal - application sources for internal usage

* /pkg - application sources for external usage(SDK and libraries)

* /test - some stuff for testing purposes

## Commands

```sh

# install dev tools(wire, golangci-lint, swag, ginkgo)

make install-tools

# start test environment from docker-compose-test.yml

make start-docker-compose-test

# stop test environment from docker-compose-test.yml

make stop-docker-compose-test

# build application

make build

# run all tests

make test-all

# run go generate

make gen

# generate OpenAPI docs with swag

make swagger

# generate source code from .proto files

make proto

# generate dependencies with wire

make deps

```

## Tools and packages

* gin-gonic

* ginkgo with gomega

* viper

* envy

* zerolog

* golangci-lint

* wire

* swag

* migrate

* protoc

* jsonapi

* docker with docker-compose