# generator-golang-boilerplate

> Yeoman generator for a baseline Golang solution

Latest version **1.0.0** (published 2017-08-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-golang-boilerplate
pnpm add generator-golang-boilerplate
yarn add generator-golang-boilerplate
bun add generator-golang-boilerplate
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-08-02 |
| First published | 2017-08-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Adam Schmidt |
| Maintainers | adamschmidt |
| Keywords | yeoman-generator, golang, go |

## Links

- npm: https://www.npmjs.com/package/generator-golang-boilerplate
- Repository: https://github.com/adamschmidt/generator-golang-boilerplate
- Homepage: https://github.com/adamschmidt/generator-golang-boilerplate#readme
- Issues: https://github.com/adamschmidt/generator-golang-boilerplate/issues
- npm.io page: https://npm.io/package/generator-golang-boilerplate

## Dependencies (1)

- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^1.1.1

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-08-02

## README

# generator-golang-boilerplate

[![Build Status](https://travis-ci.org/adamschmidt/generator-golang-boilerplate.svg?branch=master)](/adamschmidt/generator-golang-boilerplate)

> Yeoman generator for Golang projects - quick setup of a project with a build script and Docker configuration

# About

The Golang boilerplate generator enables you to bootstrap a Golang project. The default generator produces a structure to support a single binary application.

## Installation
```bash
# Make sure both is installed globally
npm install -g yo
npm install -g generator-golang-boilerplate
```

## Setting up Projects

The Yeoman generator needs two arguments supplied on the command line: your website domain; and your app name.

```bash
# Create a new directory, and `cd` into it:
mkdir my-new-project && cd my-new-project

# Run the generator
yo golang-boilerplate mysite.org testapp
```

## Working on Your New Project

Once you've initialised your application, there are a few make tasks available:

* Run `make install-build-deps install-dev-tools` to install the development tools and initial dependencies (required)
* You can build the application to run locally using `make install`
* With a Docker machine created and the appropriate environment variables set, you can build and run the application inside a container using `make deploy-local`

---
_Source: https://npm.io/package/generator-golang-boilerplate · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._