Getting Started

You got your React project ready, and it's time to infuse it with eye-catching and dynamic components. This installation guide will steer you through the process of integrating our component library seamlessly into your project.

Installation

You can install all components in the library with the following command:

npm install @vibrant-ui/components

Authorization

Please note that all packages are private and can only be installed with an authentication token from Github with the read:packages scope. To add the token to your global .npmrc file, run the following command:

npm config set "@nettbureau:registry" https://npm.pkg.github.com/
npm config set "@vibrant-ui:registry" https://npm.pkg.github.com/
npm config set "//npm.pkg.github.com/:_authToken" INSERT_TOKEN_HERE

In addition, the icon component requires Font Awesome Pro packages, which can be installed using a Font Awesome authentication token. You can obtain the token using Nettbureau's preferred password manager. Add the key to your global .npmrc file by running the following command:

npm config set "@fortawesome:registry" https://npm.fontawesome.com/
npm config set "//npm.fontawesome.com/:_authToken" INSERT_TOKEN_HERE