Next.jsReactStarter

uswds_nextjs_starter — Next.js Starter Template

By adhocteam

A USWDS starter project based on React and Next.js, for quickly building or prototyping U.S. Web Design System sites, with built-in accessibility checks and a GitHub Pages deployment workflow.

Explore the design

Compare the page layouts and mobile experience. Open any screenshot for a closer look.

2 previews
Desktop homepage1 / 2
Desktop captureTop of page

Actual screenshot captured by the server browser.

All pages & views 2

Screenshots show visual appearance; interactive behavior may differ.

Recorded 2026-10-13View source

What stands out

A quick read of the recorded project description.

01

Build USWDS sites with React and Next.js; the README positions it for quick starts and prototyping

02

Automatically deploy via the GitHub Pages workflow on every push

03

The manual build command is npm run export, with output in the out directory

04

CI runs ESLint (core web vitals preset), Lighthouse CI, and axe; it fails if accessibility standards are not met

05

Modifying USWDS settings in uswds-settings.scss takes effect via immediate compilation in development mode

06

The README lists two similar repositories: the pure HTML uswds_html_starter and the Next.js template template-application-nextjs

Template Details

The goal of this repository is to let users build a simple USWDS (US Web Design System) site with React as quickly as possible, suitable for new sites or rapid prototyping. The README states that it deploys automatically via GitHub Pages on every push, with the deployment workflow located at .github/workflows/github-pages.yml; for a manual build, run npm run export, and the output goes to the out directory. During development, first run npm install, then run npm run dev to start a development server with hot reloading. The CI job on every push runs ESLint (core web vitals preset), Lighthouse CI (fails if the accessibility score is not 100%, configured in the .github/lighthouse directory), and axe (fails if there are any failing items). After modifying USWDS settings in assets/stylesheets/uswds-settings.scss, the development mode server reflects the changes once compilation completes. The README does not provide specific framework version numbers, a component list, routing structure, or deployment methods other than GitHub Pages.

Next.jsReactStarter

Is it right for your project?

Use Cases

  • Quickly building a React site prototype that uses USWDS
  • Introducing automated accessibility checks (Lighthouse CI and axe) into a project
  • Automatically publishing a static site via GitHub Pages
  • Adjusting USWDS Sass variables during development and seeing the effect immediately

Suitable For

  • Developers who want to start a USWDS site with React and Next.js
  • Teams that need a static site starter template with accessibility CI checks
  • Projects planning to host demos or prototypes on GitHub Pages

Getting started & customization

Use these recorded setup notes alongside the repository instructions for your chosen version.

  1. 1

    Run npm install to install dependencies

  2. 2

    Run npm run dev to start a development server with hot reloading

  3. 3

    Run npm run export to build manually; output is in the out directory

  4. 4

    USWDS settings changes are located in assets/stylesheets/uswds-settings.scss

  5. 5

    Automatic deployment relies on .github/workflows/github-pages.yml; CI configuration is in the .github/workflows/ci.yml and .github/lighthouse directories

Read repository instructions

License & source material

Usage conditions & limitations

Free to use · keep license notice

This entry covers the free version under the MIT license in the public repository; the free scope is the code of this version and does not mean external services or third-party assets are free.

Must comply with when using

  • Free use, modification, commercial use, and distribution of this version's code are permitted.
  • When distributing copies or substantial portions of the code, retain the original author's copyright notice and the full MIT license notice.
  • The code is provided as is; warranties and limitations of liability are governed by the original license and applicable law.

Additional costs & items to verify

  • Demo images, fonts, icons, and other third-party assets must be checked against their respective licenses; they cannot be judged solely by the code's MIT license.
  • External services such as domains, hosting, databases, payments, or AI may incur additional charges.
View Original Text Basis

Compiled by DeepSeek based on repository license and README ·2026-10-13. Results only cover the materials read; dependencies, images, fonts, and subsequent term changes are subject to their respective original texts.

Project checks & description sources

Template Information

Source platforms
GitHub
Documentation and maintenance reference score
More documented · 77 / 100
Technologies
Next.js · React
Website type
Starter
How this score is calculated

Our heuristic uses license records (up to 30), a demo link (12), a preview (10), stars (15), recorded maintenance (15), description completeness (8), feature records (5) and classification data (5). It is not a code, security or performance test, or a Google score. A link does not establish tested functionality.

What to verify for this project

Repository update recorded
2024-07-25
Screenshot last checked
2026-10-13

A demo link is listed. Check it with your own content and viewport sizes; its presence does not confirm that forms, authentication or payments work.

The catalog identifies Next.js as the primary stack. Check the actual dependency manifest and lockfile for versions and hosting requirements. These notes use recorded metadata, not a code audit or a deployment test.

Use a selection guide →

How this description was prepared

AI-assisted description based on catalog records and repository material. Repository authors are not automatically the reviewers of this description.

Review declaration: codex-user-requested-batch-review-20261015 · 2026-10-15

Inspect the recorded source material

SHA-256: 658ab1c941079b5fdd6818615bc3a0271488f07dc3776dc6bb842c1048540f2c

2026-10-13T17:17:42.390Z

Source file / repository
# USWDS NextJS Starter

This repository aims to get you up and running with a simple [US Web Design
System](https://designsystem.digital.gov/) 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/](https://adhocteam.github.io/uswds_nextjs_starter/)

## Deployment

This repository deploys to GitHub pages on every push, via [this workflow
job](.github/workflows/github-pages.yml).

To build it manually, run `npm run export`, and you will find the site in the
`out` directory

## Development

Run `npm install` then `npm run dev` to turn on the dev server with hot reloading

## Accessibility

On every push, the [CI job](.github/workflows/ci.yml):

- runs ESLint with the reasonably strict [core web vitals](https://nextjs.org/docs/basic-features/eslint#core-web-vitals) preset
- runs [Lighthouse CI](https://github.com/treosh/lighthouse-ci-action) and fails if the accessibility score isn't 100%
  - config is located in the `.github/lighthouse` directory
- runs [axe](https://www.npmjs.com/package/@axe-core/cli) and fails if anything doesn't pass

Check out [accessibility.digital.gov](https://accessibility.digital.gov) for
good resources on why this is so important

## Changing USWDS sass variables

If you update any [uswds
settings](https://designsystem.digital.gov/documentation/settings/) in [the
uswds settings sass file](assets/stylesheets/uswds-settings.scss) while you're
running the dev mode server, you'll see your changes reflected in the page as
soon as it compiles.

## Contributing

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.

## Similar repositories

- [adhocteam/uswds_html_starter](https://github.com/adhocteam/uswds_html_starter) is a similar USWDS starter project, but using plain HTML
- [navapbc/template-application-nextjs](https://github.com/navapbc/template-application-nextjs) is a similar template app with Next.js + React and a somewhat different focus
Report a correction

Explore similar templates

Compare previews and descriptions within the same stack and category.