https://github.com/siriwatknp/joy-treasury
Design inspiration alive with Joy UI. Copy & paste ready-to-use blocks to your project or clone them with joy-treasury CLI.
https://github.com/siriwatknp/joy-treasury
joy-ui react
Last synced: over 1 year ago
JSON representation
Design inspiration alive with Joy UI. Copy & paste ready-to-use blocks to your project or clone them with joy-treasury CLI.
- Host: GitHub
- URL: https://github.com/siriwatknp/joy-treasury
- Owner: siriwatknp
- License: mit
- Created: 2023-07-16T01:26:02.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-03T07:45:25.000Z (over 2 years ago)
- Last Synced: 2025-02-27T14:48:16.883Z (over 1 year ago)
- Topics: joy-ui, react
- Language: TypeScript
- Homepage: https://joy-treasury.dev
- Size: 8.55 MB
- Stars: 41
- Watchers: 2
- Forks: 27
- Open Issues: 62
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 👋 Welcome! to Joy Treasury
[](#contributors-)
Joy Treasury is a collection of blocks that are ready-to-use for [Joy UI](https://mui.com/joy-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/joy-treasury/issues/new) if it does not).
- Use [CLI](#cli) to clone the latest blocks to your project.
## CLI
1. go to [joy-treasury](https://siriwatknp.github.io/joy-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 joy-treasury@latest clone card-news-maldives`
5. you will see that the code is downloaded to `src/joy-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 joy-treasury clone [blocks...]`
```bash
Usage: npx joy-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 `joy-treasury.config.js` file that will be used when running `clone`.
```bash
npx joy-treasury@latest init
```
> Note that config file will be overridden by cli options (if specified)
### `clone`
```bash
Usage: npx joy-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 modules**
```bash
npx joy-treasury@latest clone card-news-maldives card-travel-spa
```
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
kevintruo
💻
bossthanawat
💻
Pob Ch
💻
mildiemilk
💻
Anner
💻
Tlezip
💻
Wasu Winitmontri
💻
Napatchol Thaipanich
💻
Sila Setthakan-anan
💻
Supawit
💻
DKKs
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!