https://github.com/groovili/go-wagen

Single binary web application generator for Go
https://github.com/groovili/go-wagen

app-template boilerplate generator go go-tool golang project-boilerplate project-template tool webapp

Last synced: 9 days ago
JSON representation

Single binary web application generator for Go

• Host: GitHub
• URL: https://github.com/groovili/go-wagen
• Owner: groovili
• License: mit
• Created: 2020-05-13T14:30:53.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-05-28T18:28:46.000Z (over 4 years ago)
• Last Synced: 2024-10-14T06:23:15.424Z (23 days ago)
• Topics: app-template, boilerplate, generator, go, go-tool, golang, project-boilerplate, project-template, tool, webapp
• Language: Go
• Homepage:
• Size: 37.1 KB
• Stars: 33
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# go-wagen

[![Go Report Card](https://goreportcard.com/badge/github.com/groovili/go-wagen)](https://goreportcard.com/report/github.com/groovili/go-wagen)

Single binary **web application generator** for Go. 

**Creates boilerplate** and does routine on a project start.

Less than in a minute you've got simple, clean and dockerized app:

[![asciicast](https://asciinema.org/a/334826.svg)](https://asciinema.org/a/334826)

#### Generates:

 * project layout, according to community best practices

 * Makefile for wrapping project related routines 

 * Dockerfile and docker-compose for local development

 * containers for code, tests and [golangci-lint](https://github.com/golangci/golangci-lint)

 * configuration management with [viper](https://github.com/spf13/viper)

 * logging with [logrus](http://github.com/sirupsen/logrus) or [zap](https://github.com/uber-go/zap)

 * routing with [gorilla/mux](https://github.com/gorilla/mux) or [chi](github.com/go-chi/chi)

 * default health check, http handler and logger middleware

 

 **go-wagen is a starter pack** for typical web application in Golang. 

 

 It doesn't aim to generalize the whole project workflow, push framework, or architecture.

 Consists of framework-agnostic components that are very common.

 

 All contributions, issues, requests or feedback are warmly welcome.

 

 ## Installation

 

 Install pre-built binary on [releases page](https://github.com/groovili/go-wagen/releases):

 

 1. `curl -LJO https://github.com/groovili/go-wagen/releases/download/v1.0.0/go-wagen-osx.tar.gz`

 2. `tar -f go-wagen-osx.tar.gz -x`

 

 or build from source code:

 

 1. `git clone https://github.com/groovili/go-wagen && cd go-wagen`

 2. `make install` - will install [packr](https://github.com/gobuffalo/packr) to wrap templates to binary

 3. `make build`

 

 Binary doesn't need to be in `$GOPATH` and works without any dependencies.

 

 ## Usage

 

 1. `./go-wagen --path=/absoule/path/to/project` and select dependencies

 2. `cd /absoule/path/to/project`

 3. `go mod vendor`

 4. `make run` - will build and run container with code

 5. `make test` - to run container with tests

 6. `make lint` - to run linter for source code

 

 #### Structure

 

 Application generated with **go-wagen** will have following structure:

 ```

 ├── Makefile

 ├── cmd

 │   └── example

 │       └── example.go - app entrypoint

 ├── config - config presets for each env of default pipline

 │   ├── app.dev.yml

 │   ├── app.local.yml

 │   └── app.yml

 ├── deploy

 │   ├── Dockerfile

 │   └── docker-compose.yml

 ├── go.mod

 ├── internal - for shared internal tools

 ├── server

 │   ├── handlers

 │   │   ├── hello.go

 │   │   └── ping.go

 │   └── middleware

 │       └── log.go

 ├── storage - db/storages

 └── vendor - downloaded modules

```