Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grokify/goheroku
CLI app to kickstart a Go app for Heroku by creating boilerplate files.
https://github.com/grokify/goheroku
cli cli-command cli-utility heroku heroku-apps
Last synced: 7 days ago
JSON representation
CLI app to kickstart a Go app for Heroku by creating boilerplate files.
- Host: GitHub
- URL: https://github.com/grokify/goheroku
- Owner: grokify
- License: mit
- Created: 2018-05-19T04:37:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-08T06:46:15.000Z (about 1 month ago)
- Last Synced: 2024-10-12T00:49:05.686Z (about 1 month ago)
- Topics: cli, cli-command, cli-utility, heroku, heroku-apps
- Language: Go
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GoHeroku - Heroku Golang Helper
[![Build Status][build-status-svg]][build-status-url]
[![Go Report Card][goreport-svg]][goreport-url]
[![Docs][docs-godoc-svg]][docs-godoc-url]
[![License][license-svg]][license-url]
[build-status-svg]: https://github.com/grokify/goheroku/workflows/build/badge.svg
[build-status-url]: https://github.com/grokify/goheroku/actions
[goreport-svg]: https://goreportcard.com/badge/github.com/grokify/goheroku
[goreport-url]: https://goreportcard.com/report/github.com/grokify/goheroku
[docs-godoc-svg]: https://img.shields.io/badge/docs-godoc-blue.svg
[docs-godoc-url]: https://godoc.org/github.com/grokify/goheroku
[license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
[license-url]: https://github.com/grokify/goheroku/blob/master/LICENSE
CLI app to create boilerplate for a Heroku Go app. These files will also enable the "Deploy to Heroku" button to function.
## Installation
```
$ go get github.com/grokify/goheroku
```
## Usage
```
$ goheroku my-project
Writing file 1: my-project/.env
Writing file 2: my-project/app.json
Writing file 3: my-project/Dockerfile
Writing file 4: my-project/heroku.yml
Writing file 5: my-project/Makefile
Writing file 6: my-project/Procfile
DONE
```
You will need to use `go mod init` to create your `go.mod` file. Add the following Heroku directive to your `go.mod` file above the go version number line.
```
// +heroku goVersion go1.16
go 1.16
```
## Updating Project Docs
Once your repo is ready for Heroku, you can add various options to "Deploy to Heroku" to your `README.md` file. The following includes adding a shield, button, and a CLI manual mode.
### Shield
The following adds a shield that looks like  to your file.
```markdown
[![Heroku][heroku-svg]][heroku-url]
[heroku-svg]: https://img.shields.io/badge/%E2%86%91_deploy-Heroku-7056bf.svg?style=flat
[heroku-url]: https://heroku.com/deploy
```
### Button
The following adds a button that looks like  to your file.
```markdown
[](https://heroku.com/deploy)
```
### Manual
```sh
$ heroku create
$ git push heroku master
$ heroku open
```
## More Info
Find information on deploying Go apps on Heroku here:
* Developer Guide: https://devcenter.heroku.com/articles/go-support
* Example Project: https://github.com/heroku/go-getting-started
=====