birthbaum/code-for-chicago-jekyll

code-for-chicago-jekyll

Setup

To run locally, you will need npm, gem amd ruby's bundle installed and available on your path. Skip to the Prerequisites section below for information on installing those.

1. Clone this repository
2. cd into the root directory of this project.
3. Install npm dependencies with npm install
4. Install gem dependencies with bundle install
5. Run the server locally, recompiling files as needed, with bundle exec jekyll serve
6. Open http://localhost:4000/ in your browser to view the site.

Prerequisites

node & npm

Note: This project is not currently compatible with node v15.0.0 and above.

To verify you have node installed:

> node -v
v10.15.2

To verify you have npm installed:

> npm -v
6.10.0

If they or not installed, or your version looks much older than this, proceed to instructions for installing npm

ruby

It is advisable to avoid using the OS install of Ruby that comes bundled with MacOS, Ubuntu, and others. Instead we'd suggest using a Ruby virtual environment like rbenv. Installation instructions can be found here.

To verify your ruby version:

> ruby -v
ruby 2.5.5p157 (2019-03-15 revision 67260) [x86_64-linux-gnu]

You should have at least ruby 2.1.0.

bundler

To install bundler, use:

> gem install bundler

Find us on our slack #general channel if we can be of assistance getting you set up.

All contributions are very welcome. (see this guide)Thank you!