This project was bootstrapped with Create React Library.
All library files are located inside src/lib folder.
Inside src/demo folder, you can test your library while developing.
In the project directory, you can run:
or npm start
Runs the library in development mode. Open http://localhost:3000 to view it in the browser.
or npm run test
yarn run test
Runs the test watcher in an interactive mode.
or npm run build
Builds the library for production to the
It correctly bundles React in production mode and optimizes the build for the best performance.
or npm run storybook
Starts the storybook components explorer on port 6006.
Publishes the library to NPM.
Usage of other libraries within your library
- Add the library as a peer dependency in package.json (effectively requiring the calling project to provide this dependency)
- Add the library as a dev dependency in package.json (effectively allowing this library to successfully build without complaining about not having this dependency)
- Add the library to the externals config in your webpack.config file(s). By default, only react and react-dom are there, meaning that those are the only two libraries that you can use within your new shared library.