reusable-components-react-demo

    1.0.0 • Public • Published

    Logo

    Reusable React Components

    An awesome project to publish your own components in npm

    Table of Contents
    1. About The Project
    2. Getting Started
    3. Usage
    4. Contributing
    5. Contact

    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

    1. Clone the repo

      git clone https://github.com/ridouku/reusable-components-react.git
    2. Install NPM packages

      npm install
    3. Modify package.json and assets/package.json to use your own data and then publish the components

    4. Build your custom components

    5. Generate your components to publish

      npm run build
    6. Publish your components

      npm run publish-cmp
    7. 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.

    1. Fork the Project
    2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
    3. Commit your Changes (git commit -m 'Add some AmazingFeature')
    4. Push to the Branch (git push origin feature/AmazingFeature)
    5. Open a Pull Request

    Contact

    Bryan Arellano - ridouku@gmail.com

    Project Link: Reusable components react

    Install

    npm i reusable-components-react-demo

    DownloadsWeekly Downloads

    0

    Version

    1.0.0

    License

    ISC

    Unpacked Size

    15.5 kB

    Total Files

    19

    Last publish

    Collaborators

    • barellano