Node

The Node version used in this project is v14. Nevertheless be sure to run the latest available version of NPM

nvm install-latest-npm

Development in the lib

1- Initialize the project by installing the packages with resource to:

npm run init

2- Run the src-code compiler:

npm start

3- In a seperate cli window run the following to see a live preview of the lib in a project:

cd example
npm start

Important notice

If you want to add Peer Dependencies to the library make sure to add as Dev Dependencies to your package.json so that they are installed locally, thus your compiler does not complain about missing libs: just check how it is being done on other external libs (e.g. React). Last but not least, be sure that when you add this library, to install all the Peer Dependencies. For the example project just check how its being done for the other libraries and follow.

@creditshelf/ui-lib

CS React UI Library

Installing the UI lib

npm install @creditshelf/ui-lib

Usage

import React from 'react';

import MyComponent from '@creditshelf/ui-lib';

import '@creditshelf/ui-lib/dist/index.css';

...

const Example: React.FC<PropsInterface> = ({props}) => {
  return (
    <MyComponent />
  )
}

License

MIT ©