1.0.4 • Published 6 months ago

create-vrrtts v1.0.4

Weekly downloads
-
License
-
Repository
-
Last release
6 months ago

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:

  1. Clone the repository:

    git clone https://github.com/yourusername/create-vrrtts.git
    cd create-vrrtts
  2. Install dependencies:

    pnpm install
  3. Link it locally for testing:

    pnpm link --global
  4. Test your changes:

    pnpm create vrrtts test-project

License

MIT

1.0.4

6 months ago

1.0.3

6 months ago

1.0.2

6 months ago

1.0.1

6 months ago

1.0.0

6 months ago