https://github.com/urbaninstitute/dataviz-components
Svelte components for data visualization
https://github.com/urbaninstitute/dataviz-components
Last synced: 2 months ago
JSON representation
Svelte components for data visualization
- Host: GitHub
- URL: https://github.com/urbaninstitute/dataviz-components
- Owner: UrbanInstitute
- Created: 2023-10-27T19:34:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-24T22:03:21.000Z (3 months ago)
- Last Synced: 2025-02-24T23:19:32.669Z (3 months ago)
- Language: Svelte
- Homepage: https://urbaninstitute.github.io/dataviz-components/
- Size: 16 MB
- Stars: 8
- Watchers: 7
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# dataviz-components
Svelte components built for Urban Institute data viz projects.
Library documentation: https://urbaninstitute.github.io/dataviz-components
## Developing
The primrary method for developing new components locally is by running [Storybook](https://storybook.js.org/) locally. To do this, first install dependencies with
```bash
npm install
```
You can then run storybook with
```bash
npm run storybook
```
## Building
To build your library:
```bash
npm run package
```
### CLI-based command for creating new component boilerplate
To create three boilerplate files for a new component (`ComponentName.svelte`, `ComponentName.stories.svelte`, and `ComponentName.docs.md`), run the following command:
```bash
npm run create-component
```
## Contributing to this library
When contributing to this library, keep the following guidelines in mind. The [pull request template](https://github.com/UrbanInstitute/dataviz-components/blob/main/.github/pull_request_template.md) requires explanation of changes and provides a checklist of tasks to ensure clean code and documentation. Please name all branches in `kebab-case`, beginning with "patch", "feature", or "bugfix", and provide insightful commit messages.