codeforsacramento.org

Code for Sacramento is a platform for civic innovation. As an open source organization, you can fork our code including our website. Help us make the site better by forking it, adding new content or features, and submitting a pull request!

Requirements - via Docker (preferred unless you have issues installing and running docker)

• Docker
• Git
• Text Editor

Installation - via Docker

Clone the Repository

git clone https://github.com/code4sac/codeforsacramento.org.git

cd codeforsacramento.org

Run via docker compose

docker-compose up

Keep this tab open and running while you are viewing/editing. Press ctrl + c to exit when you are finished.

docker-compose build

If you have previously built the Docker image and are getting an error concerning Ruby packages, try to rebuild the Docker image.

Requirements - installing on operating system without Docker

• Ruby 1.9.3 or later
• Bundler
• Git
• Text Editor

Installation

Clone the Repository

git clone https://github.com/code4sac/codeforsacramento.org.git

Install Dependencies

bundle

Build the Pages

jekyll build

Serve the Pages

jekyll serve --watch

Hack Away

With jekyll serve --watch running, you should be able to access the site on http://localhost:4000! Thanks to the --watch flag, any changes you make to the markdown (md) files will update automatically!

For reference, here's an awesome markdown cheatsheet.

Contribute, change things, submit a pull request! We will all contribute.