louis-pvs / mrcw

A layer of React wrapper for official Material Components (Web)

Material React Component - Web (MRCW)

A layer of React wrapper for official Material Components - Web

Build React application fast⚡, customizable easily 💄 🎀 with Material design's ecosystem.

Table of content

• Getting Started
  • Install
  • Usage
• Built With
• Contributing
• Versioning
• Authors
  • Contributors
• License
• Acknowledgments

Getting Started

Install

1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

2. You need to have React project setup,

3. yarn add mrcw or npm install mrcw --save

Usage

import mrcw into your project

import { Button } from 'mrcw';

const App = () => {
  return (
    <div>
      <Button>Hello world<Button>
    </div>
  )
}

Built With

• Material Design
• React

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Louis Phang

Contributors

Contributing to existing issues are most welcome.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• If you happen to pump into here but looking for something production ready, there is existing project rmwc by @jamesmfriedman, this project started two years after.
• So why another similiar project? To learn how open source work... Eventually, to contribute.