Twy'r MDC Web
TABLE OF CONTENTS
ABOUT
This is a monorepo used for the development and maintenance of the Ember implementation of Material Components for the Web, and consists of two packages - the Ember MDC Web Addon itself, and an Ember App for testing, debugging, documenting, and showcasing the addon.
STATUS
Category | Status |
---|---|
Conventions | |
Code Stats | |
Security | |
Development | |
Issues & PRs | |
Release Status | |
Publish Status |
WHY
Just because...
GOALS
Ember-related goals:
- Build for Ember 4.0+ - with no expectation of backward compatibility
- Build using Embroider - aim for "Native Support"
MDC Web related goals:
- Build using the latest release of MDC for the Web 13.0+ - with no expectation of backward compatibility
- Re-use MDC Javascript API for utilities (Ripples, etc.) to provide a "MDC Native" feel for the Ember components
- Build using the SCSS files provided by MDC Web - extend/enhance only if necessary
CONTRIBUTING
Code of Conduct
All contributors to this project are expected to adhere to the Code of Conduct specified.
Developing
Details on getting the code, setting up the development environment, and instructions on how to extend/build/test the code are detailed in the Contribution Guide
Contributors
This project owes its existence to these wonderful people (emoji key):
Vish Desai |
This project follows the all-contributors specification. Contributions of any kind are welcome!
LICENSE
This project is licensed under the MIT +no-false-attribs license. You may get a copy of the license by following the link, or at LICENSE.md