aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d0a605b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+
+# go-getting-started
+
+A barebones Go app, which can easily be deployed to Heroku.
+
+This application supports the [Getting Started with Go on Heroku](https://devcenter.heroku.com/articles/getting-started-with-go) article - check it out.
+
+## Running Locally
+
+Make sure you have [Go](http://golang.org/doc/install) version 1.12 or newer and the [Heroku Toolbelt](https://toolbelt.heroku.com/) installed.
+
+```sh
+$ git clone https://github.com/heroku/go-getting-started.git
+$ cd go-getting-started
+$ go build -o bin/go-getting-started -v . # or `go build -o bin/go-getting-started.exe -v .` in git bash
+github.com/mattn/go-colorable
+gopkg.in/bluesuncorp/validator.v5
+golang.org/x/net/context
+github.com/heroku/x/hmetrics
+github.com/gin-gonic/gin/render
+github.com/manucorporat/sse
+github.com/heroku/x/hmetrics/onload
+github.com/gin-gonic/gin/binding
+github.com/gin-gonic/gin
+github.com/heroku/go-getting-started
+$ heroku local
+```
+
+Your app should now be running on [localhost:5000](http://localhost:5000/).
+
+## Deploying to Heroku
+
+```sh
+$ heroku create
+$ git push heroku main
+$ heroku open
+```
+
+or
+
+[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
+
+
+## Documentation
+
+For more information about using Go on Heroku, see these Dev Center articles:
+
+- [Go on Heroku](https://devcenter.heroku.com/categories/go)