@scaffit/web
v1.0.0
Published
Scaffit Web Dashboard - Lightweight React UI for scaffold management
Maintainers
Readme
@scaffit/web
Web dashboard for Scaffit - Visual scaffold management interface.
Features
- Scaffold Browser: Browse and search available scaffolds
- Visual Configuration: Configure scaffolds with forms instead of CLI prompts
- Live Preview: See file changes before installing
- Project Dashboard: Manage installed scaffolds
- Minimal Dependencies: Only React + ReactDOM runtime dependencies
Usage
The web UI is launched automatically when you run:
scaffit uiThis will:
- Check if @scaffit/web is installed
- Install it automatically if needed
- Start the Vite dev server
- Open your browser to http://localhost:3000
Architecture
- Framework: React 18 with TypeScript
- Build Tool: Vite with esbuild
- Styling: Tailwind CSS
- State: React Context (no external state management)
- Icons: Inline SVG components
- API: Custom Vite middleware for /api routes
Development
# Install dependencies
pnpm install
# Start dev server
pnpm dev
# Build for production
pnpm buildAPI Endpoints
The web UI communicates with the CLI through these endpoints:
GET /api/scaffolds- List available scaffoldsPOST /api/install- Install a scaffoldPOST /api/preview- Get preview of changes
Components
- Button - Styled button component
- Card - Container component
- Input - Form input component
- CodeBlock - Code display component
- SearchBar - Search functionality
Views
- Home - Scaffold browser and search
- Detail - Scaffold configuration and preview
- Installed - Manage installed scaffolds
