Repository files navigation

This repository aims to get you up and running with a simpleUS Web DesignSystem site using React as quickly andsimply as possible, to facilitate new sites or easy prototyping.

Visit the page that this site generates athttps://adhocteam.github.io/uswds_nextjs_starter/

This repository deploys to GitHub pages on every push, viathis workflowjob.

To build it manually, runnpm run export, and you will find the site in theout directory

Runnpm install thennpm run dev to turn on the dev server with hot reloading

On every push, theCI job:

• runs ESLint with the reasonably strictcore web vitals preset
• runsLighthouse CI and fails if the accessibility score isn't 100%
  • config is located in the.github/lighthouse directory
• runsaxe and fails if anything doesn't pass

Check outaccessibility.digital.gov forgood resources on why this is so important

If you update anyuswdssettings intheuswds settings sass file while you'rerunning the dev mode server, you'll see your changes reflected in the page assoon as it compiles.

This repo accepts contributions! Just file a PR.

Feel free to create a discussion topic if you have an idea and you wantfeedback on it before starting to work on it.

• adhocteam/uswds_html_starter is a similar USWDS starter project, but using plain HTML
• navapbc/template-application-nextjs is a similar template app with Next.js + React and a somewhat different focus