components
React components for the dsmjs.com site
Usage
Installation
$ npm install @dsmjs/components --save-prod
Contribution
Find common contributing details in our
organization-level contribution guide
and project specific details below.
Dependencies
Use nvm to enable the expected version of
node
$ nvm install
Install npm packages
$ npm install
View the components in isolation locally
$ npm start
Navigate to the running instance of
storybook
Development
Find details about the project structure and more specific details about our
approach to building components here.
Verification
Ensure that your changes pass the automated verification scripts
$ npm test
:eyes: Note: The verification script is executed automatically as a
pre-commit
hook.
We leverage husky to configure git hooks
like this automatically for you.
We've been sponsored with a plan from Percy so that we can
use their great visual testing tool with this project. Be sure to take a look at
how the integration with PRs to
this project works. We're using the Storybook for React integration,
which makes adding and managing the benefits of Percy incredibly easy.