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: Utility-first styling for rapid UI development.
- Vitest & Vue Test Utils: Unit and UI testing configured.
- ESLint & OXLint: Automated linting and code style enforcement.
- 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 >= 18 and Yarn >= 4.x
corepack enable
# 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 UI testing interface |
yarn test:coverage |
Generate test coverage report |
yarn lint |
Run ESLint and OXLint with auto-fix |
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 | https://tailwindcss.com |
| eslint & plugins | Linting and code style | https://eslint.org |
| 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 |
Contributions are welcome! Fork the repository, create a feature branch, commit your changes, and open a pull request.
This project is licensed under the MIT License - 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.