Overview
Comet is a React with TypeScript Component Library based on USWDS. Originally focused on USWDS, it has evolved into a framework for React Apps that require USWDS, as well as other functionality such as charts and custom components. The goal of Comet is to provide a set of modular tools that enhance developer productivity and simplify the use of Design Systems, particularly USWDS.
Features
- comet-uswds: The base USWDS component library implemented in React with TypeScript.
- comet-data-viz: A set of Victory Chart components provided as a Comet wrapper.
- comet-extras: A set of custom components intended to complement USWDS by filling in the gaps where it does not provide an implementation.
- comet-cli: A CLI for creating Comet Apps.
Installation
To get started with Comet, you can use the provided starter app which includes all the components. This starter app also offers some opinionated tools to further streamline the setup process. However, these additions are optional.
To install Comet, follow these steps:
- Clone the Comet Starter App repository: Comet Starter App.
- Review the documentation in each package directory for more information on getting started.
Summary
Comet is a React with TypeScript Component Library that is based on USWDS. It offers a range of features including a base USWDS component library, a set of Victory Chart components, custom components, and a CLI for creating Comet Apps. The goal of Comet is to simplify the use of Design Systems, particularly USWDS, and accelerate developer productivity. To get started with Comet, you can use the provided starter app or refer to the documentation in each package directory for more information.