Skip to content
This repository has been archived by the owner on Mar 2, 2022. It is now read-only.

Latest commit

 

History

History
59 lines (42 loc) · 1.53 KB

README.md

File metadata and controls

59 lines (42 loc) · 1.53 KB
description
Building your first service

Getting Started with ColdBrew

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, type:

$ cookiecutter gh:go-coldbrew/cookiecutter-coldbrew

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

Warning: After this point, change 'github.com/ankurs', 'MyApp', etc to your own information.

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

source_path [github.com/ankurs]: github.com/ankurs
app_name [MyApp]: MyApp
grpc_package [github.com.ankurs]: github.com.ankurs
service_name [MySvc]: MySvc
project_short_description [A Golang project.]: A Golang project
docker_image [alpine:latest]:
docker_build_image [golang]:
Select docker_build_image_version:
1 - 1.15
2 - 1.16
Choose from 1, 2 [1]: 2

Enter the project and take a look around:

$ cd MyApp/
$ ls

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

$ make run