Skip to content

census-coil/data-kit-hub

Repository files navigation

CircleCI

Data Kit Hub

The Opportunity Project presents Data Kit Hub, a curated web app for data exploration on select themes. This project is based on the USWDS Federalist Jekyll theme.

Installation

Clone the repository.

$ git clone https://github.com/18F/federalist-uswds-jekyll
$ cd federalist-uswds-jekyll

Install the Node.js dependencies.

$ npm install

Build the site.

$ npm run build

Run the site locally.

$ npm start

Open your web browser to localhost:4000 to view your site.

After you make changes, be sure to run the tests.

$ npm test

Note that when built by Federalist, npm run federalist is used instead of the build script.

Technologies you should be familiarize yourself with

  • Jekyll - The primary site engine that builds your code and content.
  • Front Matter - The top of each page/post includes keywords within -- tags. This is meta data that helps Jekyll build the site, but you can also use it to pass custom variables.
  • U.S. Web Design System v 2.0

Contributing

See CONTRIBUTING for additional information.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

About

Curated Datasets brought to you by The Opportunity Project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages