README
Components that are commonly used within 42.nl products.
Installation
Setup
# with yarn
yarn add @42.nl/ui
# with npm
npm i @42.nl/ui --save
Contributing
Detailled steps can be found at https://42bv.github.io/ui.
Setup
- Ensure you have Node.js 10.13+ and Yarn installed.
- Git clone the repository.
- From the root of the repository, run
yarn
to install the dependencies required for development.
Testing
First follow the build instructions above. Then to run both the linters and tests, use:
npm run test-all
Or to run them seperately, use:
npm run lint
npm run test
Development
To prevent multiple prelease publishes for a single feature, we recommend using https://verdaccio.org/. 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
by running: npm install --registry http://localhost:4873
.
Now you can test the package locally without a publish to the actual NPM registry.