README.md

Development

Local Development

You can use *storybook to play around with the components locally:

yarn storybook

# or

npm run storybook

Using Icons

We have access to the FontAwesome free icons library. But we only import the ones we need to keep bundle size down.

To add a new icon:

1. Go to src/lib/icons.ts
2. Import it at the top, and add it to the list of exports at the bottom

To use icons:

<FontAwesomeIcon icon="icon name" />

Icons are typesafe, so if you use the wrong name in the FontAwesomeIcon component it'll warn you.