History

James Phillips 6daf26ada4 Adds documentation for the transaction endpoint.		2016-05-11 14:18:47 -07:00
..
scripts	Update website metadata fixes	2016-04-12 20:14:56 +01:00
source	Adds documentation for the transaction endpoint.	2016-05-11 14:18:47 -07:00
Gemfile	…
Gemfile.lock	…
LICENSE.md	…
Makefile	…
README.md	…
Vagrantfile	…
config.rb	Updates website to version 0.6.4.	2016-03-16 10:36:57 -07:00
config.ru	…
packer.json	Update website metadata fixes	2016-04-12 20:14:56 +01: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 make dev.

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.