lre-react

What is lre-react?

lre-react is a library of reusable components tailored specifically to LRE Water use cases. The components are meant for use with React and are an extension of the Material UI framework. This library has grown out of the LRE Starterkit and is meant to compliment the Starterkit as well as any other React project that uses Material UI.

Useful Links

• Github Repo (https://github.com/)
• lre-react on npm (https://www.npmjs.com/package/@lrewater/lre-react)

Why does this project exist?

After developing several projects using the Starterkit, some commonalities started to emerge. I found that I was adding on the same custom functionality across projects and that when I discovered a bug I would need to update the code for the component in the active projects, any other projects that used a similar custom component, and then in the lre-starterkit template repository. This process is exhausting and prone to error. As a result, I thought it would make more sense to maintain a library of custom components that is then a dependency of the Staterkit. This makes maintenance much easier as the code only has to be maintained in one location vs across many projects.

Install

As lre-react a public package hosted on npm, you can install it from the command line just like any other npm module. To install the package, open up a terminal and navigate to the project where you would like to use lre-react and run

npm install @lrewater/lre-react

Easy as that!

Material UI Peer Dependency

[DOCUMENTATION PLACEHOLDER]

Note: If you are using a LRE Starter Kit, there is no need to install lre-react as it is already included as a dependency in the starter kits.