History

Armon Dadgar bb16e94b0c website: document addresses config		2014-09-02 12:49:52 -07:00
..
helpers	website: web is not an OS	2014-05-01 11:35:25 -07:00
source	website: document addresses config	2014-09-02 12:49:52 -07:00
.buildpacks	website: bulk copy from serf	2014-02-07 16:41:03 -08:00
Gemfile	Disable compression for now	2014-04-14 15:11:23 -07:00
Gemfile.lock	website: update gemfile lock and add version text	2014-04-14 15:17:33 -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 - how to build & deploy site	2014-09-02 09:20:37 -07:00
Vagrantfile	website: homepage copy and some stylesheet fixes	2014-04-14 11:02:28 -07:00
config.rb	Disable compression for now	2014-04-14 15:11:23 -07:00
config.ru	website: bulk copy from serf	2014-02-07 16:41:03 -08:00
dummy.txt	website: Update dummy	2014-07-21 11:26:53 -04:00
version.txt	website: up version for website	2014-04-17 09:37:28 -07: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.