https://github.com/wardbox/shadowfax-ui
https://github.com/wardbox/shadowfax-ui
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/wardbox/shadowfax-ui
- Owner: wardbox
- License: mit
- Created: 2025-02-13T19:32:10.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-13T21:20:18.000Z (3 months ago)
- Last Synced: 2025-02-13T21:41:59.214Z (3 months ago)
- Language: TypeScript
- Size: 1.95 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# shadowfax-ui
A tool for managing shadcn components with base/brand layering. This monorepo contains both the CLI tool and an example app demonstrating its usage.
## Project Structure
```
shadowfax-ui/
├─ packages/
│ ├─ cli/ # The core CLI tool
│ └─ example-app/ # Example Next.js app using the tool
├─ pnpm-workspace.yaml
└─ README.md
```
## Getting Started
1. Install dependencies:
```bash
pnpm install
```
2. Build the CLI:
```bash
cd packages/cli
pnpm build
```
3. Try it in the example app:
```bash
cd ../example-app
pnpm link ../cli # Link the local CLI package
pnpm shadowfax init
pnpm shadowfax add button
```
## Available Commands
- `shadowfax init` - Initialize the base/brand component structure
- `shadowfax add ` - Add a new component
- `shadowfax update ` - Update an existing component
- `shadowfax brand list` - List all brand overrides
## Development
- The CLI source is in `packages/cli/src/`
- The example app is a standard Next.js app in `packages/example-app/`
- Run `pnpm build -r` from the root to build all packages
## License
MIT