justinpocta / 18f-project-guide

A guide for managing projects at 18F

18F Project Guide

This guide was developed for 18F employees, but we hope it’s a useful reference for anyone.

Running the site

The 18F Project Guide runs on Jekyll.

To run it locally:

1. Make sure that you have Ruby 2.3. At present, this project is incompatible with Ruby 2.4.
2. Clone the repository.
3. Get Jekyll and the necessary dependencies: bundle install
4. Run the web server with ./go serve (or jekyll serve if you have Jekyll installed globally)
5. Visit the local site at http://localhost:4000

Note that you will also need Node.js in order for the site's built-in search functionality to work. If you don't have it, that's ok--the search functionality won't work for you, though.

Running the site with Docker

If you don't want to have to deal with making sure that you have the proper version of Ruby and Node installed, you can use Docker instead. It takes care of all the dependencies for you.

1. Install Docker Community Edition.
2. Clone the repository.
3. Run docker-compose up.
4. Visit the local site at http://localhost:4000

If you ever decide that you no longer want to use Docker, run docker-compose down -v to properly clean everything up.

Public domain

This project is in the worldwide public domain.

As a work of the United States government, this project is in the public domain within the United States.

Additionally, we waive copyright and related rights in the work worldwide through the CC0 1.0 Universal public domain dedication.