franklin-ui-library

A simple component library based upon MUI components, designed for the Franklin web app and Chrome extension.

Clone repository and install dependencies

# navigate to the repository root
yarn # Install dependencies

Building the code

yarn build # For building the code with typechecking
yarn build:swc # For building without typechecking

Testing the code

yarn test # For running unit test
yarn test:watch # For watching unit test

Initialize Storybook

"storybook:build" # build storybook code
"storybook:start" # start storybook on port 6006
# see package.json for additional storybook scripts covering deployment and actions 

Testing locally

To test locally, navigate to the root directory of franklin-ui-library and run the following command:

yarn link-local

to expose this library for local package management. You may then create an empty sandbox project and add the following scripts in its package.json:

"link-local-lib": "yarn link franklin-ui-library && yarn link react && yarn link react-dom && yarn add link:{{ PATH_TO }}/franklin-ui-library",
"unlink-local-lib": "yarn remove franklin-ui-library && yarn unlink franklin-ui-library && yarn unlink react && yarn unlink react-dom && yarn add franklin-ui-library"

Run yarn link-local-lib from the root of your test project once it is set up in order to inject the local library as a dependency. I suggest running 'yarn unlink-local-lib' in your test project and 'yarn unlink-local' in the franklin-ui-library project when done.