Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/materializecss/materialize
Materialize, a web framework based on Material Design
https://github.com/materializecss/materialize
css css-framework js material material-design material-ui materialize materializecss
Last synced: about 1 month ago
JSON representation
Materialize, a web framework based on Material Design
- Host: GitHub
- URL: https://github.com/materializecss/materialize
- Owner: materializecss
- License: mit
- Fork: true (Dogfalo/materialize)
- Created: 2020-05-02T22:06:48.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T08:19:35.000Z (about 2 months ago)
- Last Synced: 2024-10-30T08:48:19.307Z (about 1 month ago)
- Topics: css, css-framework, js, material, material-design, material-ui, materialize, materializecss
- Language: TypeScript
- Homepage: https://materializeweb.com/
- Size: 162 MB
- Stars: 910
- Watchers: 36
- Forks: 105
- Open Issues: 70
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- fucking-awesome-css-frameworks - Repo
- awesome-css-frameworks - Repo
README
Materialize
Materialize, a CSS Framework based on Material Design.
[ Browse the docs ]
## Quickstart
Read the [getting started guide](https://materializeweb.com/getting-started.html) for more information on how to use materialize.
- [Download the latest release](https://github.com/materializecss/materialize/releases/latest) of materialize directly from GitHub. ([Beta](https://github.com/materializecss/materialize/releases/))
- Clone the repo: `git clone https://github.com/materializecss/materialize.git`
- Include the files via [jsDelivr](https://www.jsdelivr.com/package/npm/@materializecss/materialize).
- Install with [npm](https://www.npmjs.com): `npm install @materializecss/materialize` (Beta: `npm install @materializecss/materialize@next`)
## 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.
Otherwise, if you want to develop the components itself, the dev process of this core-repo works like this:
```sh
npm install
npm run dev
```
### Running documentation locally
See [Materialize Docs Repo](https://github.com/materializecss/materialize-docs) to see Materialize in Action.
### Documentation for previous releases
Previous releases are available [here](https://github.com/materializecss/materialize/releases).
## Release
If you want to release `materialize.css` or `materialize.js` from the latest commit, you can build the files with the following command after `npm install`. See `package.json` to check the current version like `1.0.0`.
```sh
npm run release -- --oldver= --newver=
```
## Supported Browsers:
Materialize is compatible with:
- Chrome 35+
- Firefox 31+
- Safari 9+
- Opera
- Edge
## Changelog
For changelogs, check out [the Releases section of materialize](https://github.com/materializecss/materialize/releases) or the [CHANGELOG.md](CHANGELOG.md).
## 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](CONTRIBUTING.md#jasmine-testing-guide).
## Contributing
Check out the [CONTRIBUTING document](CONTRIBUTING.md) in the root of the repository to learn how you can contribute. You can also browse the [help-wanted](https://github.com/materializecss/materialize/labels/help-wanted) tag in our issue tracker to find things to do.
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/materialize#sponsor)]
[](https://opencollective.com/materialize/sponsor/0/website)
[](https://opencollective.com/materialize/sponsor/1/website)
[](https://opencollective.com/materialize/sponsor/2/website)
[](https://opencollective.com/materialize/sponsor/3/website)
[](https://opencollective.com/materialize/sponsor/4/website)
[](https://opencollective.com/materialize/sponsor/5/website)
[](https://opencollective.com/materialize/sponsor/6/website)
[](https://opencollective.com/materialize/sponsor/7/website)
[](https://opencollective.com/materialize/sponsor/8/website)
[](https://opencollective.com/materialize/sponsor/9/website)
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/materialize#backer)]
[](https://opencollective.com/materialize#backers)
## Copyright and license
Code Copyright 2024 Materialize. Code released under the MIT license.