Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/metrostar/comet
React with TypeScript Component Library based on USWDS 3.0
https://github.com/metrostar/comet
cli comet-components component-library components design-systems react storybook tanstack-table typescript ui uswds victory-charts vite
Last synced: 10 days ago
JSON representation
React with TypeScript Component Library based on USWDS 3.0
- Host: GitHub
- URL: https://github.com/metrostar/comet
- Owner: MetroStar
- License: apache-2.0
- Created: 2022-10-17T20:21:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-18T03:05:57.000Z (10 days ago)
- Last Synced: 2024-12-18T03:12:37.742Z (10 days ago)
- Topics: cli, comet-components, component-library, components, design-systems, react, storybook, tanstack-table, typescript, ui, uswds, victory-charts, vite
- Language: TypeScript
- Homepage: https://metrostar.github.io/comet/
- Size: 24.2 MB
- Stars: 20
- Watchers: 8
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Comet is a React with TypeScript Component Library based on USWDS.
In the beginning, Comet was built with a primary focus of USWDS. Today however, it has become more of a framework for React Apps which require USWDS, as well as other functionality (charts, custom components, etc). In the end, we hope to provide a set of modular tools to accelerate developer productivity and simplify the use of Design Systems, particularly USWDS.
## Table of Contents
1. [Overview](#overview)
2. [Getting Started](#getting-started)
3. [Running the Project Locally](#running-the-project-locally)
4. [Want to help?](#want-to-help)
## Overview
Comet consists of multiple packages, each providing specific functionality. These packages can be used independently or all together, depending on your use case. See below for more details on each package:
- [comet-uswds](https://github.com/MetroStar/comet/tree/main/packages/comet-uswds) - The base USWDS component library implemented in React with TypeScript.
- [comet-data-viz](https://github.com/MetroStar/comet/tree/main/packages/comet-data-viz) - A set of Victory Chart components provided as a Comet wrapper.
- [comet-extras](https://github.com/MetroStar/comet/tree/main/packages/comet-extras) - A set of custom components, intended to fill in the gaps where USWDS does not provide an implementation.
- [comet-cli](https://github.com/MetroStar/comet/tree/main/packages/comet-cli) - A CLI for creating Comet Apps.
## Getting Started
In order to simplify the process of getting started, we have provided a starter app which includes our components. This app also provides some additional opinionated tools to further accelerate the process of getting started. These additions are not required. The starter app repo can be found here: [Comet Starter App](https://github.com/MetroStar/comet-starter).
See each package directory for additional information on getting started.
## Running the Project Locally
1. To install dependencies, run the following:
```sh
npm install
```
2. To start storybook, run the following:
```sh
npm run storybook
```
## Want to help?
Interested in contributing to any of the packages in this project? Review our contributing info here: [Contributing](https://github.com/MetroStar/comet/blob/main/CONTRIBUTING.md).