Skip to main content

Installation Guide

Our libraries are distributed as a private npm packages, so you need to have access to our private npm registry to install them.

Add or update your .npmrc file​

To access our private npm registry, you will need a token that will be provided by our team. Once you have the token, you need to add it to your .npmrc file.

Create or update the .npmrc file in your project root directory with the following content:

note

Note that if you are using yarn, you will need to add the registry key with the npm registry URL.

legacy-peer-deps is a flag that allows you to install packages that have peer dependencies that are not satisfied by the installed packages. This flag is necessary for recent Angular versions.

.npmrc
//npm.pkg.github.com/:_authToken=YOUR_PROVIDED_TOKEN
registry=https://registry.npmjs.org/
@celerofinancas:registry=https://npm.pkg.github.com/
legacy-peer-deps=true

About .npmrc file​

.npmrc works as a configuration file for npm. It allows you to set environment variables, authentication tokens, and other settings that npm will use when running commands.

Npm or yarn will look for this file in the project root directory and in the user's home directory. The project root directory file will take precedence over the user's home directory file.

If you need to set different configurations for different projects, you can create a .npmrc file for each project. But, if you need to set configurations that will be used in all projects, you can edit the .npmrc file in the user's home directory.

For more information about .npmrc file, check the official npm documentation.

Good to go! 🚘​

Now you are ready to install our libraries. You can follow the installation instructions in the each library section.