mateoclarke / codeforamerica.org

The @codeforamerica website

Home Page:http://www.codeforamerica.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status

Code For America Dot Org

This repository holds the source code and static assets for codeforamerica.org. Learn more about what Code for America does on our About page.

How It Works

We use Github like a content management system -- all our templates and content are collaboratively edited by staff and external contributors on Github. We use Jekyll to generate everything into static HTML files that are served using Apache.

How We Built it

Our technology and communications teams built the site in partnership with Brighton web design firm Clearleft and Colorado branding firm Dojo4. Ongoing maintenance and improvements on the site are done collaboratively with internal staff and external volunteers. Members of the CfA community are welcomed to provide their input using Github issues, or help make improvements by submitting a Pull Request.

Who’s Working On It

... and many more CfA staff members and community contributors.

How to contribute

Specific help we need

We need your help to keep our content accurate and up to date. The easiest way for to help is to submit a pull request with one of the below:

  • For staff and members of the community, find yourself and your friends on one of the team pages and let us know if your bio is correct and photo current. Note: Personal photos should be about 200 x 200px.
  • If you built an app or project as part of the fellowship or accelerator programs, find it on the apps page and verify that it's described accurately.
  • Check government information for brigades and fellowships on the 2015 government partners and alumni government partners pages and fill in any blanks you might find.

Submitting a Pull Request

An easy way to submit a pull request for just simple text changes is to:

  1. Find the page you'd like to edit on the master branch.
  2. Use GitHub's built in editor to make your changes.
  3. Down below the editor window, include a brief one sentence description of what you changed. Something like "Updated Andrew Hyder's bio".
  4. Click the green Propose File Change button.
  5. You'll get to review your changes. If everything looks right, click the green "Send pull request" button.

If you need to add or replace an image, you'll need to:

  1. Fork the project.
  2. Create a topic branch.
  3. Add the image in the correct directory.
  4. Commit and push your changes.
  5. Submit a pull request.

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a screenshot and any additioanl details that can help us debug, such as your operating system and browser version.

Previewing Your Changes Using Jekit

You can use the nifty Jekit app to preview changes you make to this site.

To do this, fork this repo, and commit your changes on a branch to your fork. You can then preview what your changes look like by navigating to:

https://jekit.codeforamerica.org/USERNAME/codeforamerica.org/BRANCHNAME/

For a basic example of its usage, if GitHub user @lolname has made changes to the /people/dave-guarino page on their fork (on the master branch), they can preview their changes using Jekit by going to:

https://jekit.codeforamerica.org/lolname/codeforamerica.org/master/people/dave-guarino/

Running the Site Locally on Your Computer

To run the site locally on your own computer (most helpful for previewing your own changes), you will need Jekyll installed (click here for Jekyll installation instructions.)

Fork and clone the repository, then run the following command in the root directory of the repo:

jekyll serve

or

jekyll serve --watch which will watch for changes to files.

Your computer should now be serving your local copy of the site at:

http://0.0.0.0:4000.

Editing stylesheets

All CSS and stylesheets are hosted in the pattern-library repository, and served lived from http://style.codeforamerica.org.

Technology Patterns

Uses Jekyll for templating – converted HTML files are in the _site folder.

Copyright

Copyright (c) 2009-2014 Code for America. See LICENSE for details.

About

The @codeforamerica website

http://www.codeforamerica.org

License:Other


Languages

Language:HTML 91.8%Language:CSS 5.1%Language:JavaScript 1.9%Language:ApacheConf 0.5%Language:Python 0.5%Language:Ruby 0.1%Language:Shell 0.0%Language:PHP 0.0%