open-consul/website
Ryan Uber 9de7d95109 website: fix mention of read-only policy for service acls 2015-06-18 18:13:01 -07:00
..
source website: fix mention of read-only policy for service acls 2015-06-18 18:13:01 -07:00
.buildpacks website: bulk copy from serf 2014-02-07 16:41:03 -08:00
Gemfile Use new middleman-hashicorp 2015-05-15 16:06:10 -04:00
Gemfile.lock Fixing yanked gem 2015-05-18 14:44:50 -07:00
LICENSE.md website: fix name in license 2014-04-17 11:31:12 -04:00
Procfile website: bulk copy from serf 2014-02-07 16:41:03 -08:00
README.md website: Force deploy (newline) 2015-02-23 16:56:42 -08:00
Vagrantfile website: homepage copy and some stylesheet fixes 2014-04-14 11:02:28 -07:00
config.rb Bump version references 2015-05-18 14:37:27 -07:00
config.ru Disable rack rewrite 2015-01-02 16:31:03 -05:00

README.md

Consul Website

This subdirectory contains the entire source for the Consul Website. This is a Middleman project, which builds a static site from these source files.

Contributions Welcome!

If you find a typo or you feel like you can improve the HTML, CSS, or JavaScript, we welcome contributions. Feel free to open issues or pull requests like any normal GitHub project, and we'll merge it in.

Running the Site Locally

Running the site locally is simple. Clone this repo and run the following commands:

$ bundle
$ bundle exec middleman server

Then open up localhost:4567. Note that some URLs you may need to append ".html" to make them work (in the navigation and such).

Building Site

Building the static version of the site and running it is simple. Clone this repo and run the following commands:

$ bundle
$ bundle exec middleman build
$ foreman start

Then open up localhost:5000.

Alternately, the site can now be deployed to Heroku or Cloud Foundry.