Skip to content

Commit

Permalink
Add instructions on Heroku deployment.
Browse files Browse the repository at this point in the history
  • Loading branch information
Rishabh Rao committed May 14, 2015
1 parent 3b27e67 commit 53ea3b8
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Voxel [:star:](https://github.com/rishabhsrao/voxel)
# Voxel [:star:](https://voxel-rsr.herokuapp.com/dist)

> A minimal Hologram theme.
Expand All @@ -10,6 +10,11 @@
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](license.md)


## :star: Live demo

The live demo is hosted on Heroku at [voxel-rsr.herokuapp.com/dist](https://voxel-rsr.herokuapp.com/dist).


## :rowboat: Get started

This project depends on the following tools:
Expand Down Expand Up @@ -72,6 +77,22 @@ bundle clean --force && bundle install
... to keep your repository lean and mean.


## :rocket: Deploy

This project is continuously deployed to [Heroku](http://voxel-rsr.herokuapp.com/dist) using a [NodeJS](https://github.com/heroku/heroku-buildpack-nodejs) [buildpack](https://devcenter.heroku.com/articles/buildpacks) by [Travis](https://travis-ci.org/rishabhsrao/remember), whenever a new tag is pushed. This should be configured **only once** using the [Heroku toolbelt](https://toolbelt.heroku.com):

```
heroku create voxel-rsr
git push heroku master
heroku ps:scale web=1
heroku config:set BUILDPACK_URL=https://github.com/heroku/heroku-buildpack-nodejs#v75 --app voxel-rsr
```

:tophat: **Tip** The `heroku ps:scale web=1` will spin up a [dyno](https://devcenter.heroku.com/articles/dynos) under the [free](https://blog.heroku.com/archives/2015/5/7/heroku-free-dynos) plan.
:tophat: **Tip** The `#75` above is the [release tag](https://github.com/heroku/heroku-buildpack-nodejs/releases) for the project. Use the latest tag for best results.
:tophat: **Tip** The non-minified version of this project is also deployed to [Heroku at /app](http://voxel-rsr.herokuapp.com/app).


## :scroll: License

See [license.md](license.md).

0 comments on commit 53ea3b8

Please sign in to comment.