Skip to content
This repository has been archived by the owner on Apr 12, 2024. It is now read-only.

Home

Jump to bottom
John Skiles Skinner edited this page Jun 15, 2023 · 5 revisions

Welcome to the De-risking government technology wiki!

This is an in-progress repo to create digital versions State and Federal De-risking Government Technology. The repo is a fork of the 18F theme of the federalist-uswds-jekyll.

See the Federalist repo for more documentation and details on content management.

Setup

Installation for development

$ git clone https://github.com/18F/derisking-gov-tech
$ cd derisking-gov-tech

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

Install dependencies and run app

You will need version 2.7.* of Ruby. You may need to switch to this version with your Ruby version manager (e.g. rvm use).

$ npm install
$ bundle install
$ npm start

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

Testing

$ npm test

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.

Clone this wiki locally