kmaterialize
kmaterialize, a CSS Framework based on Material Design.
[ Browse the docs ]
## Getting started
Read the [getting started guide](https://materialize.kevinzarshenas.com/getting-started.html) for more information on how to use kmaterialize.
- Clone the repo: `git clone https://github.com/kekefreedog/kmaterialize.git`
- Install with [npm](https://www.npmjs.com): `npm install kmaterialize`
## Testing
To run tests locally you first have to build the files and then run the tests. This can be done with the command `npm test`;
To get more info and debug information you can do the following:
run `npx jasmine-browser-runner` then go to the url via browser `http://localhost:8888`. The tests will then run and show detailed feedback.
## Development
The documentation can be found at . To run the documentation locally on your machine, you need [Node.js](https://nodejs.org) installed on your computer.
This is the core project with all the components. To see how they are used we recommend using an example project or go to the documentation.
### Running documentation locally
kmaterialize doesn't have its own docs site yet. See the upstream [Materialize Docs Repo](https://github.com/materializecss/materialize-docs) for an example of Materialize's components in action.
### Releases
Previous releases are available [here](https://github.com/kekefreedog/kmaterialize/releases). You can also find the changelog under each release.
## Supported Browsers:
Materialize is compatible with:
- Chrome 35+
- Firefox 31+
- Safari 9+
- Opera
- Edge
## Testing
We use Jasmine as our testing framework and we're trying to write a robust test suite for our components. If you want to help, [here's a starting guide on how to write tests in Jasmine](docs/CONTRIBUTING.md#jasmine-testing-guide).
## Quick Testing and Development
For quick testing install live-server node package globally and run `npm run demo`
## Contributing
Check out the [CONTRIBUTING document](docs/CONTRIBUTING.md) in the root of the repository to learn how you can contribute.
## Copyright and license
Code Copyright 2026 kmaterialize. Code released under the MIT license.