Contributing

Overview

Github pages are compiled with a ruby gem called Jekyll, which allows, amongst other things, the ability to compile markdown and display it on a webpage. In order to properly contribute to the pages that form this site, you must install jekyll on your local machine, and learn how to launch a jekyll server via the command line. To do that, follow the Quick Start below

Quick Start

Install Ruby

To determine whether or not ruby is installed on your machine, open your terminal and run the following command

ruby --version

If ruby is installed, you can move on to Launching your server. Otherwise, follow the tutorial here to get ruby up and running in your environment.

Launching Your Server

1. clone the github repo onto your site. If you are not sure how to do this, follow the tutorial at githubpages

2. Once the repo is cloned to your local machine, open your terminal and navigate to the directory where your project is cloned.

   cd /path/to/codeandcoffe-repo

3. In order to launch the server, you must first install the ruby bundler (necessary for most ruby projects) in order to properly read dependancies from our Gemfile.

   gem install bundler

4. Once the bundler is installed, you can simply run bundle install to install all dependancies needed for our project.

   bundle install

5. Lastly, to launch your server, run

   bundle exec jekyll serve

If all goes well, you should be able to navigate in your web browser of choice to localhost:4000 and see the index file from our repo loaded.