Introduction

This repository contains the source for the Code for Nashville website. The site is hosted on Github Pages. Changes merged to the master branch of this repository are automatically deployed to the live site.

Prerequisites

• Ruby (programming language)
• Gem (ruby's built-in package manager)
• Bundler (a dependency tracker for gems)
• Homebrew (optional, see below)
• rbenv (optional, see below)

Make sure you have ruby installed. If ruby comes with your system, you may want to do a clean install. For example, if you use MacOs, you should probably install brew and run

brew install rbenv
rbenv install 2.5.3 # or latest version of ruby

Homebrew is a MacOS package manager that gives you rbenv, which lets you do a clean install of Ruby (and Gem).

Contributing

The website is generated with Jekyll, so to contribute you'll need to have that installed.

This is how to set it up:

1. Clone this repo
2. Run 'bundle install' to install required dependencies. If you don't have bundler, you can install it with 'gem install bundler' or check out bundler's site for help. You may also need xcode installed by running 'xcode-select --install' in the command line.
3. Run locally with bundle exec jekyll serve

Changes to our website follow the Github Flow. You need git installed and some experience with Github. If you are not experienced with git, check out Github's documentation or ask another brigade member for help.

The process is

1. Create a branch
2. Make your changes
3. Test them locally with bundle exec jekyll serve
4. Commit your changes
5. Push your changes
6. Open a pull request
7. Wait for someone else to review your code
8. Once it gets a thumbs-up, merge your branch
9. Check the site and see your changes