Home

Awesome

scaffold

Build Status codecov Go Report Card GoDoc

Scaffold generates starter Go project layout. Let you can focus on buesiness logic implemeted.

asciicast

The following is Go project layout scaffold generated:

├── Dockerfile
├── Makefile
├── README.md
├── cmd
│   └── main.go
├── config
│   ├── config.go
│   ├── config.yml
│   ├── database.go
│   ├── http.go
│   └── release.go
├── docker-compose.yml
├── model
│   └── model.go
└── web
    ├── routes.go
    ├── server.go
    └── version.go

Installation

Download scaffold by using:

$ go get -u github.com/catchplay/scaffold

Create a new project

  1. Going to your new project folder:
# change to project directory
$ cd $GOPATH/src/path/to/project
  1. Run scaffold init in the new project folder:
$ scaffold init
  1. That will generate a whole new starter project files like:
Create Dockerfile
Create README.md
Create cmd/main.go
Create config/config.go
Create config/database.go
Create config/http.go
Create config/release.go
Create docker-compose.yml
Create model/model.go
Create web/routes.go
Create web/server.go
Create web/version.go
Create Makefile
Create config/config.yml
Success Created. Please excute `make up` to start service.

  1. And you can run the new project by using:
$ make run