1.0.4 ⢠Published 6 months ago
create-vrrtts v1.0.4
create-vrrtts
A CLI tool to quickly scaffold Vite+React+React Router+TypeScript+Tailwind+ShadCN UI projects.
Features
- š Quick project setup with a single command
- āļø Modern React setup with React Router
- š· TypeScript support out of the box
- šØ Tailwind CSS pre-configured
- š§© ShadCN UI components ready to use
- š Organized folder structure for components, pages, and layouts
- š§© File-based routing with automatic route generation
Usage
# Create a new project
pnpm create vrrtts my-project
# Follow the prompts to configure your project
# Start development
cd my-project
pnpm install
pnpm dev
Project Structure
my-project/
āāā public/ # Static assets
āāā src/
ā āāā components/ # Reusable UI components (includes ShadCN UI)
ā āāā layout/ # Layout components
ā āāā pages/ # Page components (auto-routed)
ā āāā App.tsx # Main App component
ā āāā main.tsx # Entry point
ā āāā router.tsx # Router configuration
ā āāā index.css # Global styles
āāā index.html
āāā package.json
āāā postcss.config.js
āāā tailwind.config.js
āāā tsconfig.json
āāā vite.config.ts
File-Based Routing
Routes are automatically generated based on your file structure in the pages
directory:
src/pages/index.tsx
ā/
src/pages/about.tsx
ā/about
src/pages/users/index.tsx
ā/users
src/pages/users/$id.tsx
ā/users/:id
(dynamic parameter)
Configuration Options
When running the create command, you'll be prompted to select:
- Project name
- Language variant (TypeScript or JavaScript)
- Whether to overwrite existing directories
Development
To contribute to this project:
Clone the repository:
git clone https://github.com/yourusername/create-vrrtts.git cd create-vrrtts
Install dependencies:
pnpm install
Link it locally for testing:
pnpm link --global
Test your changes:
pnpm create vrrtts test-project
License
MIT