Kickstart Vue

An interactive CLI tool for scaffolding Vue 3 projects with customizable features.

Usage

Create a new Vue project:

npm create @vdhut/kickstart-vue@latest

Or with npx:

npx @vdhut/kickstart-vue

Then follow the prompts!

You can also directly specify the project name:

npm create @vdhut/kickstart-vue@latest my-vue-app

Features

The CLI will guide you through selecting features for your new project:

Core Features (Always Included)

• ⚡️ Vite - Lightning fast build tool
• 🖖 Vue 3 - Latest version with Composition API
• 🛣️ Vue Router - Official routing solution
• 📝 ESLint + Prettier - Code quality tools

Optional Features

• 🎨 Tailwind CSS v4 - Utility-first CSS framework
• 🗃️ Pinia - State management
• 🌍 Vue I18n - Internationalization
• 🧪 Testing - Vitest + Playwright
• 📱 PWA - Progressive Web App support

Language Choice

• TypeScript - For type-safe development
• JavaScript - For simpler projects

What You Get

The generated project includes:

• Modern project structure with best practices
• Pre-configured build tooling
• Example components and views
• Routing setup
• Optional feature integrations
• Development and production scripts
• Comprehensive README

Project Structure

your-project/
├── public/              # Static assets
├── src/
│   ├── assets/         # Project assets
│   ├── components/     # Vue components
│   ├── router/         # Router configuration
│   ├── stores/         # Pinia stores (if selected)
│   ├── views/          # Page components
│   ├── App.vue         # Root component
│   └── main.ts         # Entry point
├── index.html          # HTML template
├── vite.config.ts      # Vite configuration
├── tsconfig.json       # TypeScript config (if selected)
└── package.json        # Dependencies and scripts

Requirements

• Node.js version 18.0 or higher

Development Workflow

After creating your project:

cd your-project
npm install
npm run dev

Build for Production

npm run build
npm run preview

Learn More

• Vue 3 Documentation
• Vite Documentation
• Vue Router Documentation
• Pinia Documentation
• Tailwind CSS Documentation

License

MIT