@flrfinance/ff-react-library v0.2.37

Flare React Library

A library containing common reusable components for flare finance products.

Initial Setup

In order to use one of the npm dependencies of the flrfinance organisation you will npmjs Access Token. If you need a access token, request it from one of your coworkers. You will need to setup the token as a variable inside your terminal. The variable name shall be NPM_TOKEN. You can do so by running the following command inside your terminal:

export NPM_TOKEN=your_npm_token

Besides the variable you will need to setup an .nmprc file for your project. Don't forget to remove the file from the .gitignore file. The .npmrc file should look as following:

@flrfinance:registry=https://registry.npmjs.org
//registry.npmjs.org/:_authToken=${NPM_TOKEN}

To summarise:

• set NPM_TOKEN variable
• create an .npmrc file

Use as dependency

Run the following in terminal:

npm i @flrfinance/ff-react-library

or add in your package.json the following:

"@flrfinance/ff-react-library": "desired.version.tag",

and run:

npm i

Usage

import React, { Component } from "react";

import { MyComponent } from "flare-lib";

class Example extends Component {
  render() {
    return <MyComponent />;
  }
}

Themes

The library is using a default theme.json that can be copied and replaced.

The input theme.json (if has correct structure) will replace the default one. If value is not provided then the theme will fallback to default one

Development (Storybook)

Project has integrated storybook for showcasing the components. In order to develop live a component just run:

• npm run storbook or
• yarn storybook Making changes on the components will appear immediately in the page mentioned above

License

MIT © Flare Finance