Skip to content
This repository has been archived by the owner on Feb 28, 2023. It is now read-only.

cfpb/cfpb-uswds-gatsby

Repository files navigation

CFPB + U.S. Web Design System + Gatsby

Based on 18f's Federalist starter repo.

Running the application locally

yarn
yarn develop

Open your web browser to localhost:8000 to view the site.

Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

Deploying the application to GH pages

yarn deploy

Technologies you should be familiarize yourself with

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

  • For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

  • To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.

Things to Note

  • The Federalist script runs the Gatsby build with the --prefix-paths flag. This is necessary to make sure all internal internal links point to the correct path for preview deployments.
  • Always use the Link component provided by Gatsby for internal links, see previous note.
  • Importing USWDS images can be done straight from their local location in node_modules. See Banner.js for an example.
  • This is built from the default Gatsby default starter, you can view the documentation there to see more of what is included.

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.