@spankchain-dev/spankpay-lib
v0.0.125
Published
Library that provides general Spank react components
Downloads
19
Readme
@spankchain-dev/spankpay-lib
Library that provides general Spank react components
Install
npm install --save @spankchain-dev/spankpay-lib
Usage
In order to add this lib into the front end repositories 1- Add fonts into the project that will use the lib, the one located in => /example/public/fonts/ 2- Add font-face like /example/src/index.css
import React, { Component } from 'react';
import MyComponent from '@spankchain-dev/spankpay-lib';
class Example extends Component {
render() {
return <MyComponent />;
}
}
Local development
Install all dependencies lib
and example
in lib directory => yarn install
in example directory => yarn install
Build lib | Build lib in watch mode
in lib directory => yarn build | yarn start
Run the example
in example directory => yarn start
Storybook
We use Storybook in example enviroment, to start it just run
yarn storybook
it will start Storybook at localhost:6006
and keep watching the changes in the lib to reload it (it takes a time to rebuild the lib)
How to Publish to NPM
- Each new PR should have an updated version on the
package.json
file. (i.e. go from 0.96 to 0.97). - After approval the PR should be merged.
- Then go to Actions click on Publish to NPM and then go to the workflows table and then Run the workflow for the
develop
branch.
License
MIT © SpankPay