A lightweight, ready-to-use template for Vue 3 with Vite and TypeScript. Fully configured with essential tools to kickstart your project.
- Vue 3 & Vite: Modern framework paired with a fast development server and build tool.
- TypeScript: Static typing for safer, more maintainable code.
- Pinia & Vue Router: State management and routing out of the box.
- Tailwind CSS v4: Utility-first styling for rapid UI development.
- Vitest & Vue Test Utils: Unit and UI testing configured.
- Oxlint & Oxfmt: Fast Rust-based linting and formatting.
- Husky: Git hooks for pre-commit and pre-push checks.
- Storybook: Isolated component development and documentation.
# Clone the repository
git clone https://github.com/lazercaveman/vue-starter.git
cd vue-starter
# Ensure Node.js 24.14.0 via fnm
fnm use
# Install dependencies
yarn
# Start development server
yarn dev| Command | Description |
|---|---|
yarn dev |
Start Vite development server |
yarn build |
Run type checks and build for production |
yarn preview |
Preview the production build |
yarn test:unit |
Run unit tests with Vitest |
yarn test:ui |
Launch Vitest UI |
yarn test:coverage |
Generate test coverage report |
yarn lint |
Run Oxlint |
yarn lint:fix |
Run Oxlint with auto-fix |
yarn format |
Format code with Oxfmt |
yarn format:check |
Check formatting without writing changes |
yarn type-check |
Run vue-tsc type checking |
yarn storybook |
Start Storybook development server |
yarn build-storybook |
Build Storybook static documentation |
| Package | Purpose | Docs |
|---|---|---|
| vue | Core framework | https://vuejs.org |
| vite | Dev server and build tool | https://vitejs.dev |
| pinia | State management | https://pinia.vuejs.org |
| vue-router | Application routing | https://router.vuejs.org |
| typescript | Static type checking | https://typescriptlang.org |
| tailwindcss | Utility-first CSS (v4) | https://tailwindcss.com |
| oxlint | Fast Rust-based linter | https://oxc.rs/docs/guide/usage/linter |
| oxfmt | Fast Rust-based formatter | https://oxc.rs/docs/guide/usage/formatter |
| vitest & plugins | Testing framework | https://vitest.dev |
| @vue/test-utils | Vue component testing utilities | https://vue-test-utils.vuejs.org |
| husky | Git hooks | https://typicode.github.io/husky/ |
| storybook & addons | Component documentation and UI library | https://storybook.js.org/docs/vue/overview |
This project is licensed under the MIT License, by Ali Soueidan - see the LICENSE file for details.
Please note that the software is provided without any warranty. The authors accept no liability for any security gaps or damage that may arise from the use of the software.