@kolserdav/react-lib
v1.0.1
Published
Simple template project for create ReactJS component as npm library
Downloads
2
Readme
React component library template
Simple template project for create ReactJS component as npm library
Usage
Install and setup
- Clone source in to custom
package name
directory:
git clone https://github.com/kolserdav/react-lib.git [package-name]
- Change dir to package-name:
cd package-name
- Change git remote origin:
- Remove old:
git remote remove origin
- Add new:
git remote add origin https://github.com/user/package-name.git
- Install dependencies:
npm install
- Set up package name and version on package.json
{
"name": "package-name",
"version": "0.0.1"
}
- [OPTIONAL] Install recomended extension on .vscode/extensions.json
Run on development
Files of your future component library placed on src/package
directory
Run with live reload after change files:
npm run dev
Build before publish
Output path for compiled files is src/dist
Compile with clean extra files:
npm run build
Publish to npmjs.com
Before each publication, you need to do git push
with the new version in package.json
First publication:
npm publish --access=public
Other publication:
npm publish
Test with real world project
Can use example
application
- Change directory
cd examle
By first usage change import name of package to custom in file example/src/App.js
- Install your package:
npm insttall [package-name]
- Or if not first test, change version of
package-name
in dependencies block of example/package.json and run:
npm install
- Run example:
npm run start
It's all. The rest you will figure out for yourself.