Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.21 KB

README.md

File metadata and controls

39 lines (24 loc) · 1.21 KB
Raw

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 locally. To do this, first install dependencies with

npm install

You can then run storybook with

npm run storybook

Building

To build your library:

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:

npm run create-component

Contributing to this library

When contributing to this library, keep the following guidelines in mind. The pull request template 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.