This is the Github Pages source code for the Socrata Developer Portal (currently deployed to http://dev.socrata.com.
We love pull requests! If you'd like to contribute, feel free to fork this repo and send us pull requests.
The site is a customized Jekyll site, so there are some steps you'll need to take care of to get your environment set up:
- Make sure you have the
gh-pagesbranch checked out:git checkout -b gh-pages origin/gh-pages - Pull in the site templates and CSS/SASS, which come from submodules:
git submodule update --init - Make sure you have Ruby version installed. Check
.ruby-versionto see the preferred version. If you're using rbenv or rvm, this should automatically be set up - Install the Bundler Gem installed:
gem install bundler - Set up the Gem bundle:
bundle - Make sure you have the
jekyllRubyGem installed - You can then run one of several options on the
Rakefile, depending on your setup:rake incrementalwill perform a Jekyll build into./public. If rerun, it'll be faster since it'll only build what you have changed.rake watchwill perform an incremental build automatically when you change files, which is handy if you're using something like Powrake servewill run a standalone server for testing
Before submitting, run rake test and rake htmlproof to run the test suite and confirm that you haven't broken anything.
Site styling is controlled via css/local.sass and it's automatically regenerated by Github Pages with each push.