Skip to content

Commit

Permalink
Readme updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
jbouder committed Aug 2, 2024
1 parent 1b504dc commit d96e3d1
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
# Comet Starter - NextJS

The goal of this project is to provide a NextJS starter application, which comes pre-configured with the USWDS-based [Comet Component Library](https://github.com/MetroStar/comet) as well as other tools to accelerate development.
The goal of this project is to provide a NextJS starter application, which comes pre-configured with the USWDS-based [Comet Component Library](https://github.com/MetroStar/comet) as well as other tools to accelerate development. Some of these tools are as follows:

- Tooling: [Turbopack](https://turbo.build/)
- Platform: [Next.js](https://nextjs.org/) with [TypeScript](https://www.typescriptlang.org/)
- Component Library: [Comet Component Library](https://github.com/MetroStar/comet)
- Data Visualization: [Victory Charts](https://formidable.com/open-source/victory/)
- State Management: [Recoil](https://recoiljs.org/)
- Form Validation: [React Hook Form](https://react-hook-form.com/)
- Unit Testing: [Vitest](https://vitest.dev/) with [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/)
- End-to-End (E2E) Testing: [Playwright](https://playwright.dev/)
- API support: Next.js APIs with [Axios](https://axios-http.com/) and [React Query](https://tanstack.com/query/v3/)
- Authentication support: [NextAuth](https://next-auth.js.org/) with [Keycloak](https://www.keycloak.org/)

## Table of Contents

1. [Running the Project Locally](#running-the-project-locally)
2. [Running Unit Tests](#running-unit-tests)
3. [Running End-to-End (E2E) Tests](#running-end-to-end-e2e-tests)

## Running the Project Locally

Expand Down

0 comments on commit d96e3d1

Please sign in to comment.