Welcome to our guide to creating a suitable development environment in which to apply the best practices described in other 18F Guides. Based on the 18F Guides Template.
You will need Ruby ( > version 2.1.5 ). You may consider using a Ruby version manager such as rbenv or rvm to help ensure that Ruby version upgrades don't mean all your gems will need to be rebuilt.
On OS X, you can use Homebrew to install Ruby in
/usr/local/bin, which may require you to update your $PATH environment
variable:
$ brew update
$ brew install rubyTo create a new guide and serve it locally, where MY-NEW-GUIDE is the name
of your new repository:
$ git clone [email protected]:18F/dev-environment.git MY-NEW-GUIDE
$ cd MY-NEW-GUIDE
$ ./go init
$ ./go serveThis will check that your Ruby version is supported, install the Bundler
gem if it is not yet installed, install all the gems
needed by the site, and launch a running instance on
http://localhost:4000/dev-environment/. (Make sure to include the trailing
slash! The built-in Jekyll webserver doesn't redirect to it.)
After going through these steps, run ./go to see a list of available
commands. The serve command is the most common for routine development.
You can create an 18f-pages-staging branch and changes to that branch will
be published to https://pages.18f.gov/staging/dev-environment. Only people
authorized to access the internal 18F Hub will
be able to access this site.
This project is in the worldwide public domain. As stated in CONTRIBUTING:
This project is in the public domain within the United States, and copyright and related rights in the work world wide are waived through the CC0 1.0 universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.