Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cfpb/cfpb.github.io

A site for the CFPB to share and discuss its technology work with the world.
https://github.com/cfpb/cfpb.github.io

Last synced: about 1 month ago
JSON representation

A site for the CFPB to share and discuss its technology work with the world.

Awesome Lists containing this project

README

        

# [cfpb.github.io](https://cfpb.github.io/)

A site for the CFPB to share and discuss its technology work with the world.

## Running it locally with Docker

Content editors and developers probably want to set up cfpb.github.io on
their local machine so they can preview updates without pushing to GitHub.

Before you get started, make sure you have an up-to-date version of [Docker](https://www.docker.com/get-started/) installed on your machine and that it is running.

[Fork and clone the repo](https://help.github.com/articles/fork-a-repo/)
to your local machine.

Using terminal, in the project directory, run:
```sh
docker-compose up
```

Open it up in your browser: [http://localhost:4000/](http://localhost:4000/)

## Working with the front end

The cfpb.github.io project front end currently uses the following:

- [Jekyll](http://jekyllrb.com/): Static site generator used by GitHub Pages.

## Getting involved

We welcome your feedback and contributions.
See the [contribution guidelines](CONTRIBUTING.md) for more details.

**Note:** Currently this file has standard language geared toward code contributions.
Interested in contributing to design discussions? Just check out the
[issues](https://github.com/cfpb/cfpb.github.io/issues) and dive right in!

----

## Open source licensing info
1. [TERMS](TERMS.md)
2. [LICENSE](LICENSE)
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)