Reusable React Components
An awesome project to publish your own components in npm
Table of Contents
About The Project
This project is an alternative to bit or Storybook, to build and publish your React components in npm, simply using gulp and components wrote in typescript.
Of course, the project maybe has bugs or any problem. You may also suggest changes by forking this repo and creating a pull request or opening an issue.
Built With
This project was build it with:
Getting Started
Before you start, you must read the article where I explain all project and how it works.
Prerequisites
You must be logged with your npm account
- npm
npm login
Installation
-
Clone the repo
git clone https://github.com/ridouku/reusable-components-react.git
-
Install NPM packages
npm install
-
Modify package.json and assets/package.json to use your own data and then publish the components
-
Build your custom components
-
Generate your components to publish
npm run build
-
Publish your components
npm run publish-cmp
-
You can publish your components using access restricted or public, just modify the next line in package.json
"publish-cmp": "npm publish --access restricted lib/src/components",
Usage
You can read about this project and how it works, following the next link Documentation
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Contact
Bryan Arellano - ridouku@gmail.com
Project Link: Reusable components react