Skip to content

Commit 3b63dd0

Browse files
schneemsedmorley
schneems
and
edmorley
authored
Update readme and index to add Fir (#66)
* Update heroku local port * Add FIR to README * Update nav for Fir * Update index for fir * Update dependency link * Apply suggestions from code review Co-authored-by: Ed Morley <[email protected]> --------- Co-authored-by: Ed Morley <[email protected]>
1 parent 3b89eb1 commit 3b63dd0

File tree

3 files changed

+72
-42
lines changed

3 files changed

+72
-42
lines changed

‎README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
2-
# go-getting-started
1+
# Go Getting Started
32

43
A barebones Go app, which can easily be deployed to Heroku.
54

6-
This application supports the [Getting Started with Go on Heroku](https://devcenter.heroku.com/articles/getting-started-with-go) article - check it out.
5+
This application supports the tutorials for both the [Cedar and Fir generations](https://devcenter.heroku.com/articles/generations) of the Heroku platform. You can check them out here:
6+
7+
- [Getting Started on Heroku with Go](https://devcenter.heroku.com/articles/getting-started-with-go)
8+
- [Getting Started on Heroku Fir with Go](https://devcenter.heroku.com/articles/getting-started-with-go-fir)
79

810
## Running Locally
911

@@ -26,26 +28,36 @@ github.com/heroku/go-getting-started
2628
$ heroku local
2729
```
2830

29-
Your app should now be running on [localhost:5000](http://localhost:5000/).
31+
Your app should now be running on [localhost:5006](http://localhost:5006/).
3032

3133
## Deploying to Heroku
3234

3335
Using resources for this example app counts towards your usage. [Delete your app](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-apps-destroy) and [database](https://devcenter.heroku.com/articles/heroku-postgresql#removing-the-add-on) as soon as you are done experimenting to control costs.
3436

37+
### Deploy on Heroku [Cedar](https://devcenter.heroku.com/articles/generations#cedar)
38+
3539
By default, apps use Eco dynos if you are subscribed to Eco. Otherwise, it defaults to Basic dynos. The Eco dynos plan is shared across all Eco dynos in your account and is recommended if you plan on deploying many small apps to Heroku. Learn more about our low-cost plans [here](https://blog.heroku.com/new-low-cost-plans).
3640

3741
Eligible students can apply for platform credits through our new [Heroku for GitHub Students program](https://blog.heroku.com/github-student-developer-program).
3842

39-
```sh
43+
```text
4044
$ heroku create
4145
$ git push heroku main
4246
$ heroku open
4347
```
4448

45-
or
49+
### Deploy on Heroku [Fir](https://devcenter.heroku.com/articles/generations#fir)
4650

47-
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
51+
By default, apps on [Fir](https://devcenter.heroku.com/articles/generations#fir) use 1X-Classic dynos. To create an app on [Fir](https://devcenter.heroku.com/articles/generations#fir) you'll need to
52+
[create a private space](https://devcenter.heroku.com/articles/working-with-private-spaces#create-a-private-space)
53+
first.
4854

55+
```text
56+
$ heroku create --space <space-name>
57+
$ git push heroku main
58+
$ heroku ps:wait
59+
$ heroku open
60+
```
4961

5062
## Documentation
5163

‎templates/index.tmpl.html

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,51 +9,52 @@
99
<img src="/static/lang-logo.png">
1010
</a>
1111
<h1>Getting Started with Go on Heroku</h1>
12-
<p>This is a sample Go application deployed to Heroku. It's a reasonably simple app - but a good foundation for understanding how to get the most out of the Heroku platform.</p>
13-
<a type="button" class="btn btn-lg btn-default" href="https://devcenter.heroku.com/articles/getting-started-with-go"><span class="glyphiconglyphicon-flash"></span> Getting Started with Go</a>
14-
<a type="button" class="btn btn-lg btn-primary" href="https://github.com/heroku/go-getting-started"><span class="glyphiconglyphicon-download"></span> Source on GitHub</a>
12+
<p>This is a sample Go application deployed to Heroku. It's a reasonably simple app - but a good foundation for understanding how to get the most out of the Heroku platform.</p>
13+
<a type="button" class="btn btn-lg btn-default" href="https://devcenter.heroku.com/articles/getting-started-with-go"><span class="glyphicon glyphicon-flash"></span> Getting Started on Heroku with Go</a>
14+
<a type="button" class="btn btn-lg btn-default" href="https://devcenter.heroku.com/articles/getting-started-with-go-fir"><span class="glyphicon glyphicon-flash"></span> Getting Started on Heroku Fir with Go</a>
15+
<a type="button" class="btn btn-lg btn-primary" href="https://github.com/heroku/go-getting-started"><span class="glyphicon glyphicon-download"></span> Source on GitHub</a>
1516
</div>
1617
</div>
1718
<div class="container">
18-
<div class="alert alert-info text-center" role="alert">
19-
To deploy your own copy, and learn the fundamentals of the Heroku platform, head over to the <a href="https://devcenter.heroku.com/articles/getting-started-with-go" class="alert-link">Getting Started with Go on Heroku</a> tutorial.
19+
<div class="lead">
20+
To deploy your own copy, and learn the fundamentals of the Heroku platform, head over to either of the following tutorials:
21+
<ul>
22+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-go" class="alert-link">Getting Started on Heroku with Go</a></li>
23+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-go-fir" class="alert-link">Getting Started on Heroku Fir with Go</a></li>
24+
</ul>
2025
</div>
21-
<hr>
26+
<hr />
2227
<div class="row">
2328
<div class="col-md-6">
2429
<h3><span class="glyphicon glyphicon-info-sign"></span> How this sample app works</h3>
2530
<ul>
26-
<li>This app was deployed to Heroku, either using Git or by using <a href="https://github.com/heroku/go-getting-started">Heroku Button</a> on the repository.</li>
27-
28-
<li>When Heroku received the source code it used the go tool chain to compile the application along with any vendored dependencies and created a deployable slug.</li>
29-
<li>The platform then spins up a dyno, a lightweight container that provides an isolated environment in which the slug can be mounted and executed.</li>
30-
<li>You can scale your app, manage it, and deploy over <a href="https://addons.heroku.com/">150 add-on services</a>, from the Dashboard or CLI.</li>
31+
<li>This app was deployed to Heroku using Git.</li>
32+
<li>When Heroku received the source code it used the go tool chain to compile the application along with any vendored <a href="https://devcenter.heroku.com/articles/go-support#supported-dependency-vendor-managers">dependencies</a>, creating a deployable build artifact.</li>
33+
<li>The platform then spins up a dyno, a lightweight container that provides an isolated environment in which the build artifact can be mounted and executed.</li>
34+
<li>You can scale your app, manage it, and deploy over <a href="https://addons.heroku.com/">150 add-on services</a>, from the Dashboard or CLI.</li>
3135
</ul>
3236
</div>
3337
<div class="col-md-6">
3438
<h3><span class="glyphicon glyphicon-link"></span> Next Steps</h3>
3539
<ul>
36-
<li>If you are following the <a href="https://devcenter.heroku.com/articles/getting-started-with-go">Getting Started</a> guide, then please head back to the tutorial and follow the next steps!</li>
37-
<li>If you deployed this app by deploying the Heroku Button, then in a command line shell, run:</li>
38-
<ul>
39-
<li><code>git clone https://github.com/heroku/go-getting-started</code> - get the code into your local environment</li>
40-
<li><code>cd go-getting-started</code></li>
41-
<li><code>go install .</code> - compile the binary and install it into your $GOPATH/bin</li>
42-
<li><code>heroku git:remote -a &lt;your-app-name&gt;</code> - associate the Heroku app with the repository</li>
43-
<li>You'll now be set up to run the app locally, or <a href="https://devcenter.heroku.com/articles/getting-started-with-go#push-local-changes">deploy changes</a> to Heroku</li>
44-
</ul>
40+
<li>If you are following the <a href="https://devcenter.heroku.com/articles/getting-started-with-go">Getting Started on Heroku with Go</a> or <a href="https://devcenter.heroku.com/articles/getting-started-with-go-fir">Getting Started on Heroku Fir with Go</a> guide, then please head back to the tutorial and follow the next steps!</li>
4541
</ul>
4642
<h3><span class="glyphicon glyphicon-link"></span> Helpful Links</h3>
4743
<ul>
4844
<li><a href="https://www.heroku.com/home">Heroku</a></li>
4945
<li><a href="https://devcenter.heroku.com/">Heroku Dev Center</a></li>
50-
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-go">Getting Started with Go on Heroku</a></li>
51-
<li><a href="https://devcenter.heroku.com/articles/go-support">Heroku Go Support</a></li>
46+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-go">Getting Started on Heroku with Go</a></li>
47+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-go-fir">Getting Started on Heroku Fir with Go</a></li>
48+
<li><a href="https://devcenter.heroku.com/categories/go-support">Go articles on the Heroku Dev Center</a></li>
5249
</ul>
5350
</div>
54-
</div> <!-- row -->
55-
<div class="alert alert-info text-center" role="alert">
56-
Please do work through the Getting Started guide, even if you do know how to build such an application. The guide covers the basics of working with Heroku, and will familiarize you with all the concepts you need in order to build and deploy your own apps.
51+
</div>
52+
<div class="row" style="margin-top:1em">
53+
<div class="col-md-12">
54+
<p class="alert alert-info" role="alert">
55+
Please do work through the Getting Started guide, even if you do know how to build such an application. The guide covers the basics of working with Heroku, and will familiarize you with all the concepts you need in order to build and deploy your own apps.
56+
</p>
57+
</div>
5758
</div>
5859
</div>
5960

‎templates/nav.tmpl.html

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,38 @@
88
<a href="https://devcenter.heroku.com/articles/how-heroku-works"><span class="glyphicon glyphicon-user"></span> How Heroku Works</a>
99
</li>
1010
<li class="dropdown">
11-
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"><span class="glyphicon glyphicon-info-sign"></span> Getting Started Guides <span class="caret"></span></a>
11+
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"><span class="glyphicon glyphicon-info-sign"></span> Getting Started Guides (Cedar) <span class="caret"></span></a>
1212
<ul class="dropdown-menu" role="menu">
13-
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-ruby">Getting Started with Ruby on Heroku</a></li>
14-
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-nodejs">Getting Started with Node on Heroku</a></li>
15-
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-php">Getting Started with PHP on Heroku</a></li>
16-
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-python">Getting Started with Python on Heroku</a></li>
17-
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-java">Getting Started with Java on Heroku</a></li>
18-
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-go">Getting Started with Go on Heroku</a></li>
19-
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-clojure">Getting Started with Clojure on Heroku</a></li>
20-
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-scala">Getting Started with Scala on Heroku</a></li>
13+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-ruby">Getting Started on Heroku with Ruby</a></li>
14+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-nodejs">Getting Started on Heroku with Node.js</a></li>
15+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-php">Getting Started on Heroku with PHP</a></li>
16+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-python">Getting Started on Heroku with Python</a></li>
17+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-java">Getting Started on Heroku with Java</a></li>
18+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-clojure">Getting Started on Heroku with Clojure</a></li>
19+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-scala">Getting Started on Heroku with Scala</a></li>
20+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-go">Getting Started on Heroku with Go</a></li>
21+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-dotnet">Getting Started on Heroku with .NET</a></li>
2122
<li class="divider"></li>
2223
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-heroku-and-connect-without-local-dev">Getting Started on Heroku with Heroku Connect</a></li>
23-
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-jruby">Getting Started with Ruby on Heroku (Microsoft Windows)</a></li>
2424
</ul>
2525
</li>
26+
<li class="dropdown">
27+
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"><span class="glyphicon glyphicon-info-sign"></span> Getting Started Guides (Fir) <span class="caret"></span></a>
28+
<ul class="dropdown-menu" role="menu">
29+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-ruby-fir">Getting Started on Heroku Fir with Ruby</a></li>
30+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-nodejs-fir">Getting Started on Heroku Fir with Node.js</a></li>
31+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-php-fir">Getting Started on Heroku Fir with PHP</a></li>
32+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-python-fir">Getting Started on Heroku Fir with Python</a></li>
33+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-java-maven-fir">Getting Started on Heroku Fir with Java (Maven)</a></li>
34+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-java-gradle-fir">Getting Started on Heroku Fir with Java (Gradle)</a></li>
35+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-clojure-fir">Getting Started on Heroku Fir with Clojure</a></li>
36+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-scala-fir">Getting Started on Heroku Fir with Scala</a></li>
37+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-go-fir">Getting Started on Heroku Fir with Go</a></li>
38+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-dotnet-fir">Getting Started on Heroku Fir with .NET</a></li>
39+
<li class="divider"></li>
40+
<li><a href="https://devcenter.heroku.com/articles/getting-started-with-heroku-and-connect-without-local-dev">Getting Started on Heroku with Heroku Connect</a></li>
41+
</ul>
42+
</li>
2643
</ul>
2744
<ul class="nav navbar-nav navbar-right">
2845
<li class="navbar-right">

0 commit comments

Comments
 (0)