Material Design Front-End Framework

Overview

This project is a front-end framework implementing Material Design principles. It is developed using Lit, Webpack, and Node.js.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Development
• Contributing
• Demo and API Documentation
• License
• Contact
• Acknowledgements

Getting Started

Follow these steps to set up the framework and start developing.

Prerequisites

Ensure you have the following installed:

• Node.js (version 14 or later)
• npm (version 6 or later)

Installation

1. Clone the repository:

    git clone https://github.com/ndiing/material.git
    cd material
    

2. Install the dependencies:

    npm install
    

Usage

To use this framework in your project, install it via npm:

npm install @ndiinginc/material

Then, import the components you need in your project:

import { MyComponent } from '@ndiinginc/material';

Development

To start the development server, run:

npm run start

This command starts a local development server with hot reloading enabled.

To build the project for production, run:

npm run build

Contributing

We welcome contributions! To contribute, follow these steps:

1. Fork the repository.
2. Create a new branch:

    git checkout -b feature/YourFeature
    

3. Make your changes.
4. Commit your changes:

    git commit -am 'Add some feature'
    

5. Push to the branch:

    git push origin feature/YourFeature
    

6. Create a new Pull Request.

Demo and API Documentation

You can find the demo and API documentation here.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or inquiries, please contact ndiing.inc@gmail.com.

Acknowledgements

• Lit
• Webpack
• Node.js