https://github.com/redwoodjs/setup-rw-shad
Command for setting up rwgc in a RedwoodJS project
https://github.com/redwoodjs/setup-rw-shad
Last synced: 2 months ago
JSON representation
Command for setting up rwgc in a RedwoodJS project
- Host: GitHub
- URL: https://github.com/redwoodjs/setup-rw-shad
- Owner: redwoodjs
- License: mit
- Created: 2023-07-23T15:16:33.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-20T09:11:48.000Z (10 months ago)
- Last Synced: 2024-10-19T09:20:00.953Z (9 months ago)
- Language: TypeScript
- Size: 364 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
setup-rw-shad
=============
Command for setting up [rw-shad](https://github.com/Tobbe/rw-shad) in a RedwoodJS project
Setup
-----
```
yarn dlx setup-rw-shad
```
Run the command above inside your Redwood project and it'll setup [rw-shad](https://github.com/Tobbe/rw-shad) for you.
You'll get a tailor-made setup of [shadcn/ui](https://ui.shadcn.com) for Redwood, with a RW specific cli to generate components.
Usage
-----
Inside your Redwood project you can now use the `rw-shad` command to generate components.
For example, the command below will generate a button component
```
yarn rw-shad button
```
Note
----
Currently this doesn't work great if you've already installed custom Tailwind plugins. It won't know how to update your TW config. PRs are welcome 😉
Contributing
------------
If you want to improve TW config merging, or contribute any other changes an easy way to test this locally is:
```
yarn start --cwd ../rw-example-project --force
```
### Releasing
It's made to be released by npm (e.g. `npm run release:patch`). That way I don't have to worry about yarn v1 vs v3