appsignal-ui

AppSignal UI is a Typescript component library, documented and developed with storybook.

Every new component added should:

• have a story, documenting its behaviour
• TBD

To start development, best locally run storybook and enjoy hot reloading.

npm run storybook

Storybook should automatically open. If it does not, you should find it at: http://localhost:6006/

Release process

In order to test before publishing a release, we can use yalc and another local test project.

https://www.npmjs.com/package/yalc

First, run this command to generate assets

npm run rollup

Then, in this project, locally publish via yalc

yalc publish

Then, in the second project, add this as a dependency via yalc

yalc add @appsignal-tools/appsignal-ui

Then verify that the components can be used in the second project.

Adding SVG icons

We generate React components from SVG using svgr. If you want to add a new SVG icon:

(1) Add it to the assets folder. (2) Run npm run svgr, regenerating all SVG icons in src/icons (3) Commit both the new asset as well the React component.