Template Next.js React application
This is a template repository for a React web application using the Next.js framework.
See navapbc/platform
for other template repos.
Features
- Framework for server-side rendered, static, or hybrid React applications
- TypeScript and React testing tools
- U.S. Web Design System for themeable styling and a set of common components
- Type checking, linting, and code formatting tools
- Storybook for a frontend workshop environment
Repo structure
├── .github # GitHub workflows and repo templates
├── app # Web application
├── docs # Project docs and decision records
Installation
To get started using the template application on your project:
-
Run the download and install script in your project's root directory.
curl https://raw.githubusercontent.com/navapbc/template-application-nextjs/main/template-only-bin/download-and-install-template.sh | bash -s
This script will:
- Clone the template repository
- Copy the template files into your project directory
- Remove any files specific to the template repository, like this README.
-
Follow the steps in
app/README.md
to set up the application locally. -
Optional, if using the Platform infra template: Follow the steps in the
template-infra
README to set up the various pieces of your infrastructure.
Getting started
Now that you're all set up, you're now ready to get started.