Skip to content
This repository has been archived by the owner on May 21, 2020. It is now read-only.

Latest commit

 

History

History
69 lines (43 loc) · 4.25 KB

README.md

File metadata and controls

69 lines (43 loc) · 4.25 KB
Raw

Code For Tucson Website

This is the repository for the website for Code for Tucson, the Tucson chapter of the Code for America Brigade program. It is based on the website for Code for DC.

This site is built on Github Pages, which uses Jekyll as a templating language.

Docker

If you are looking for a whaley simple way to develop locally, just install Docker and run the following command from the project directory.

docker run --rm -v $(pwd):/site -p 4000:4000 andredumas/github-pages serve --watch --config _config.yml,_config_local.yml --baseurl '' --verbose

Dependencies

RVM Gemset [Recommended]

# Install Ruby 2.0.0
$ rvm install 2.0.0

# Create and use the Code for Tucson Gemset
$ rvm use 2.0.0@codefortucson --create

# Install the dependencies
$ bundle install

Manual Install [Not supported]

We depend on a few Ruby gems:

You should be able to install them via RubyGems. GitHub has built a meta package which pulls in all of these dependencies:

$ gem install github-pages

If you want more information on getting started with Ruby development, STOP RIGHT THERE. Use RVM instead. If you're still using Ruby in 6 months, you'll thank us profusely.

Local development and hacking

In order to run this website in your local environment, you will need to have Jekyll serve it. GitHub Pages (the host of codefortucson.org) has some strange requirements on the base URL for its sites. Before we can run and test locally, we need to overwrite the corresponding settings. Thankfully, we can do this by simply appending the local development config file to the Jekyll command, which is done for you already in the Makefile.

make

That's all it takes! Now you have a running Jekyll server on your local machine that will automatically watch for changes to the source files and update accordingly in response.

If you are using RVM, make sure you are using the correct Gemset!

$ rvm use 2.0.0@codefortucson

You should now be able to visit http://localhost:4000/ in your browser and see a copy of the Code for Tucson site hosted on your very own computer that updates when you save something! Zoiks!

To make changes:

  • Clone the repository on your computer with git clone [https or ssh repo url]. You can find this on GitHub as the Clone URL.
  • Create a new branch to work on your addition, bug-fix, or feature with git checkout -b [name of new branch]. Try to use names that describe what you are accomplishing, such as add/hackathon-project-info, fix/wrong-meeting-time, or new/funny-cat-video-page.
  • Always leave useful commit messages. Taking the time to explain your changes will help you to better understand your work and will prevent accidental mishaps.
  • When you beieve that your changes are ready for production, create a pull request with a thorough description of the changes. Include before and after screenshots or testing instructions so that someone can review the changes before merging into master.
  • If you accidentally merge into master, it's okay - GitHub renders the site from the gh-pages branch. Only stable releases from master should ever be merged into gh-pages.

Getting started with git can be confusing if you haven't worked with it before. If this describes how you feel, check out a non-programmers intro to git, then the simple guide for an overview of a git workflow, and Code School's interactive git tutorial.