Skip to content

Latest commit

 

History

History
64 lines (47 loc) · 1.88 KB

README.md

File metadata and controls

64 lines (47 loc) · 1.88 KB
Raw

repo-template

Build Status

Fork From Cookiecutter, Cookiecutter Golang is a framework for jumpstarting production-ready go projects quickly.

Features

  • Generous Makefile with management commands
  • Uses go dep

Optional Integrations

Constraints

  • Uses govendor for depency management
  • Only maintained 3rd party libraries are used.

Usage

Let's pretend you want to create a project called "echoserver". Rather than starting from scratch maybe copying some files and then editing the results to include your name, email, and various configuration issues that always get forgotten until the worst possible moment, get cookiecutter to do all the work.

First, get Cookiecutter. Trust me, it's awesome:

$ pip install cookiecutter

alternatively you can install cookiecutter with homebrew:

$ brew install cookiecutter

finally to run it based on this template just:

$ cookiecutter https://github.com/DSiSc/repo-template.git

You will be asked about your basic info (name, project name, app name, etc.). This info will be used to customize your new project.

Warning: After this point, change 'Luis Morales', 'lacion', etc to your own information.

Answer the prompts with your own desired options. For example:

full_name [Lawrence Peerlink]: Lawrence Peerlink 
github_username [DSiSc]: DSiSc 
app_name [mygolangproject]: echoserver
project_short_description [A Golang project.]: Awesome Echo Server
year [2018]: 2018
use_git [y]: y

Enter the project and take a look around:

$ cd echoserver/
$ ls

Run make help to see the available management commands, or just run make build to build your project.

$ make help
$ make test