Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/siriwatknp/mui-treasury

A collection of ready-to-use components based on Material-UI
https://github.com/siriwatknp/mui-treasury

layout material-design material-ui open-source react-components

Last synced: about 1 month ago
JSON representation

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

Host: GitHub
URL: https://github.com/siriwatknp/mui-treasury
Owner: siriwatknp
License: mit
Created: 2019-03-11T16:21:23.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-03-29T15:25:50.000Z (5 months ago)
Last Synced: 2024-04-14T04:17:43.658Z (5 months ago)
Topics: layout, material-design, material-ui, open-source, react-components
Language: TypeScript
Homepage: https://mui-treasury.com
Size: 38.1 MB
Stars: 2,338
Watchers: 28
Forks: 153
Open Issues: 49
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

best-of-react - GitHub - 15% open · ⏱️ 28.04.2024): (Other Components)
awesome-material-ui - mui-treasury - A collection of ready-to-use components based on Material-UI. (Components)

README

        # 👋 Welcome! to Material Treasury

[![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat-square)](#contributors-)

Material Treasury is a collection of blocks that are ready-to-use for [Material UI](https://mui.com/material-ui/getting-started/) projects.

The blocks are made to live from design inspiration resources such as [Dribbble](https://dribbble.com/) and [Pinterest](https://www.pinterest.com/), 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](https://github.com/siriwatknp/mui-treasury/issues/new) if it does not).

- Use [CLI](#cli) to clone the latest blocks to your project.

## CLI

1. go to [mui-treasury](https://siriwatknp.github.io/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...]`

```bash

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

Options:

  -v, --version                 output the current version

  -h, --help                    display help for command

Commands:

  init

  clone [options]   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`.

```bash

npx mui-treasury@latest init

```

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

### `clone`

```bash

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

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**

```bash

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

```

## Donation

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

- [Open Collective](https://opencollective.com/mui-treasury)

- [Patreon](https://www.patreon.com/user?u=16324303&fan_landing=true)

## Contribution

I am profoundly appreciate any [contribution](/.github/CONTRIBUTING.md) you submit, thanks.

## License

This project is licensed under the terms of the

[MIT license](/LICENSE).

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/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](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!