This repository aims to get you up and running with a simple US Web Design System site using React as quickly and simply as possible, to facilitate new sites or easy prototyping.
Visit the page that this site generates at https://adhocteam.github.io/uswds_nextjs_starter/
This repository deploys to GitHub pages on every push, via this workflow job.
To build it manually, run npm run export, and you will find the site in the
out directory
Run npm install then npm run dev to turn on the dev server with hot reloading
On every push, the CI job:
- runs ESLint with the reasonably strict core web vitals preset
- runs Lighthouse CI and fails if the accessibility score isn't 100%
- config is located in the
.github/lighthousedirectory
- config is located in the
- runs axe and fails if anything doesn't pass
Check out accessibility.digital.gov for good resources on why this is so important
If you update any uswds settings in the uswds settings sass file while you're running the dev mode server, you'll see your changes reflected in the page as soon 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 want feedback 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