An open API service indexing awesome lists of open source software.

https://github.com/abelpz/extensible-rcl

A React Utility Components Library for extending components
https://github.com/abelpz/extensible-rcl

react-component-library scripture-open-components

Last synced: 4 months ago
JSON representation

A React Utility Components Library for extending components

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]





extensible-rcl


A React Utility Components Library for RCL developers


Explore the docs and code playground »




View Demo
·
Report Bug
·
Request Feature


Table of Contents



  1. About The Project



  2. Getting Started


  3. Usage

  4. Roadmap

  5. Contributing

  6. License

  7. Contact

  8. Acknowledgments

## About The Project

**Extensible** allows RCL (React Components Libraries) developers to easily add extensibility support to their Components.

**Architecture and Design Principles:**
See ARCHITECTURE.md for details on architecture and design principles for this project.

(back to top)

### Built With

* [React.js](https://reactjs.org/)
* [React Stylguidist](https://react-styleguidist.js.org)

(back to top)

## Getting Started

This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.

### Prerequisites

**Data**

This is an example of how to list things you need to use the library and how to install them.
* npm
```sh
npm install npm@latest -g
```

### Installation/First Steps

1. Setup a React app using `Create React App` or `React Styleguidist` or any other method.
```sh
npx create-react-app my-app
```
2. Add it to your React app or component library (inside your project path):
* yarn
```sh
yarn add @gwdevs/extensible-rcl
```
* npm
```sh
npm i @gwdevs/extensible-rcl
```

(back to top)

## Usage/Integration

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Styleguidist](https://extensible-rcl.netlify.app/#extensible)._

(back to top)

## Roadmap

See the [open issues](https://github.com/gatewaydevs/extensible-rcl/issues) for a full list of proposed features (and known issues).

(back to top)

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. [Guidelines for external contributions.](https://forum.door43.org)

You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

If you would like to fork the repo and create a pull request.

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

(back to top)

## License

Distributed under the MIT License. See `LICENSE` for more information.

(back to top)

## Contact

@extensible-rcl-contact

Project Link: [https://github.com/gatewaydevs/extensible-rcl](https://github.com/gatewaydevs/extensible-rcl)

(back to top)

## Acknowledgments

* [Abel Perez](https://github.com/gatewaydevs)

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/gatewaydevs/extensible-rcl.svg?style=flat
[contributors-url]: https://github.com/gatewaydevs/extensible-rcl/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/gatewaydevs/extensible-rcl.svg?style=flat
[forks-url]: https://github.com/gatewaydevs/extensible-rcl/network/members
[stars-shield]: https://img.shields.io/github/stars/gatewaydevs/extensible-rcl.svg?style=flat
[stars-url]: https://github.com/gatewaydevs/extensible-rcl/stargazers
[issues-shield]: https://img.shields.io/github/issues/gatewaydevs/extensible-rcl.svg?style=flat
[issues-url]: https://github.com/gatewaydevs/extensible-rcl/issues
[license-shield]: https://img.shields.io/github/license/gatewaydevs/extensible-rcl.svg?style=flat
[license-url]: https://github.com/gatewaydevs/extensible-rcl/blob/master/LICENSE
[product-screenshot]: https://github.com/gatewaydevs/extensible-rcl/raw/master/public/screen-shot.png