Components that are commonly used within 42.nl products.
# with yarn yarn add @42.nl/ui # with npm npm i @42.nl/ui --save
Detailled steps can be found at https://42bv.github.io/ui.
- Ensure you have Node.js 10.13+ installed.
- Git clone the repository.
- From the root of the repository, run
npm ito install the dependencies required for development.
First follow the build instructions above. Then to run both the linters and tests, use:
Or to run them separately, use:
npm run lint
npm run test:ts
npm run test:coverage
We use Storybook to test our components
during development. To start up a local storybook, run
npm start from the root directory.
Also make sure the test coverage is 100%. To run the tests automatically on every change, run
npm run test:watch from the root directory.
If all tests pass, the test coverage is 100% and you want to test the changes in a project of your choice, you can create a local release.
To prevent multiple prelease publishes for a single feature, we recommend using Verdaccio. Verdaccio enables you to spin up a local NPM registry which in turn allows us to publish multiple versions for testing purposes without polluting the version in NPM.
We recommend the Docker approach instead of locally installing Verdaccio. If you do not want to use Docker, refer to the Verdaccio documentation.
To publish to the Verdaccio registry run
npm run dev:publish this
will spin up Verdaccio and publish.
You can view Verdaccio here:
http://localhost:4873/ it should after
a successful dev publish show the packages here.
To verify the release, install
@42.nl/ui from the Verdaccio registry in a project of your choice
npm install --registry http://localhost:4873.
Now you can test the package locally without a publish to the actual NPM registry.