open-consul/website
Sep Nasiri d644ede899 Change example filename to use .json instead of .js
Since only .json files are loaded using .js as an example here is confusing.
2015-12-08 18:42:32 -08:00
..
source Change example filename to use .json instead of .js 2015-12-08 18:42:32 -08:00
.buildpacks
Gemfile Adds and updates docs for prepared queries. 2015-11-15 17:06:00 -08:00
Gemfile.lock Use vendored fastly logo 2015-10-26 12:08:30 -04:00
LICENSE.md
Makefile Add makefile and update readme 2015-10-09 18:29:08 -04:00
Procfile
README.md Add makefile and update readme 2015-10-09 18:29:08 -04:00
Vagrantfile
config.rb Bumps the website version to 0.6.0. 2015-12-03 20:29:51 -08:00
config.ru

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.