brandonsutan / comet-starter

React with TypeScript Starter App for Comet

Welcome to the Comet Starter App!

The goal of this project is to provide a React with TypeScript starter application, which comes pre-configured with the USWDS-based Comet Component Library as well as other tools to accelerate development. Some of these tools are as follows:

• Tooling: Vite
• Platform: React with TypeScript
• Component Library: Comet Component Library
• Data Visualization: Victory Charts
• State Management: Recoil
• Form Validation: React Hook Form
• Unit Testing: Jest with React Testing Library
• Code Analysis: ES Lint
• Code Formatting: Prettier
• End-to-End (E2E) Testing: Cypress with cypress-axe
• Accessibility Testing: Unlighthouse
• API support: Axios with React Query
• Authentication support: Keycloak

Table of Contents

1. Running the Project Locally
2. Running Unit Tests
3. Running Code Quality Checks
4. Running End-to-End (E2E) Tests
5. Contributing

Running the Project Locally

1. To install dependencies, run the following:

npm install

2. To run locally with SSO, add a file called .env.local to the comet-starter directory. Copy and paste the template below and replace the placeholder values with your own (optional):

SSO_AUTHORITY=[SOME_KEYCLOAK_REALM_URL] # Ex: http://localhost:8088/realms/dev
SSO_CLIENT_ID=[SOME_CLIENT_ID] # Ex: dev-client

3. To start the app, run the following:

npm run dev

Running Unit Tests

To make sure your changes do not break any unit tests, run the following:

npm run test

Ensure to review the coverage directory for code coverage details.

npm run coverage

Running Code Quality Checks

To make sure your changes adhere to additional code quality standards, run the following:

npm run lint
npm run format

You can also see the .vscode/settings.json file to find how to enable auto-formatting on save.

Running End-to-End (E2E) Tests

Note: running E2E tests requires the app to be running as well, run the following:

npm run e2e

Contributing

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature_a)
3. Commit your Changes (git commit -m 'Added new feature_a')
4. Push to the Branch (git push origin feature_a)
5. Open a Pull Request