siriwatknp / mui-treasury

A collection of ready-to-use components based on Material-UI

👋 Welcome! to Material Treasury

Material Treasury is a collection of blocks that are ready-to-use for Material UI projects.

The blocks are made to live from design inspiration resources such as Dribbble and Pinterest, etc.

There are 2 way to use the blocks in your project.

• Copy and paste: open the "Doc" of the block you want and copy the code. Then paste it to your project, it should work instantly (open an issue if it does not).
• Use CLI to clone the latest blocks to your project.

CLI

1. go to mui-treasury
2. find a block you want to clone from the sidebar (let's say that I want the Card/News/Maldives)
3. open your terminal and go to your root project directory
4. run npx mui-treasury@latest clone card-news-maldives
5. you will see that the code is downloaded to src/mui-treasury folder (in your local project)

Note: to clone multiple blocks, just add more names to the command with a space in between, e.g. npx mui-treasury clone [blocks...]

Usage: npx mui-treasury@latest [options] [command]

Options:
  -v, --version                 output the current version
  -h, --help                    display help for command

Commands:
  init
  clone [options] <sources...>  clone components/styles to your config directory
  help [command]                display help for command

init

create a mui-treasury.config.js file that will be used when running clone.

npx mui-treasury@latest init

Note that config file will be overridden by cli options (if specified)

clone

Usage: npx mui-treasury@latest clone [options] <sources...>

clone components/styles to your config directory

Options:
  -d, --dir [directory]      destination directory
  -t, --template [template]  template of the files, typescript (default) | javascript
  -b, --branch [branch]      target branch on github
  --storybook                storybook file(s) will be included.
  --test                     test file(s) will be included.
  -h, --help                 display help for command

clone multiple blocks

npx mui-treasury@latest clone card-galaxy info-basic

Donation

To help me keep this project alive! every dollar matters.

• Open Collective
• Patreon

Contribution

I am profoundly appreciate any contribution you submit, thanks.

License

This project is licensed under the terms of the MIT license.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Siriwat Kunaporn 🎨 💻 🐛 📖 💡 🤔 📆 🚧 🚇 👀 ⚠️	Kunanan 🔧	renamoo 📖 💻	Punn Siriphanthong 💻	_borBier 💻	Thongrapee Panyapatiphan 💻	Kijpokin 💻
Davide D'Antonio 💻	Aaron Hayes 💻	tokdaniel 🐛	Alejandro Venegas 💻	Bartosz Podgruszecki 🚧	Paddy 📖 🚧 💻	Alexandre Teyar ️️️️♿️
Max Wassiljew 💻	tsutomu 💻	David Granado 🚧	Marek 💻	Matthew Lancellotti 💻

This project follows the all-contributors specification. Contributions of any kind welcome!