React Library Generator

Generate a react library with typescript, rollup, jest, react testing library and storybook support

Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
• Built With
• Prerequisites
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Generate a react library with typescript, prettier, eslint, rollup, jest, react testing library and storybook support

Built With

Bash ❤

Prerequisites

• bash
• git
• node
• yarn

Usage

• Run

  bash -c "$(wget -O - https://raw.githubusercontent.com/pavanprakash21/react-library-generator/master/entry.sh)"

  from your command line.
• It asks for the package name and the remote git url. Enter them. Remote git url is optional. You can always add it later.
• Takes about 10 minutes to complete.
• When everything is done, it will open a new tab with storybook running. Your development environment is set.

Roadmap

See the open issues for a list of proposed features (and known issues).

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

License

Distributed under the Unlicense. See LICENSE for more information.

Contact

Pavan Prakash - pavanprakash21@gmail.com

Project Link: https://github.com/pavanprakash21/react-library-generator

Acknowledgements

• README inspired by this awesome repo
• npe package which made the process so much easier
• Arrow Vectors by Vecteezy | Some random logo by this website