This is the official scaffolding tool for Vuetify, designed to give you a head start in building your new Vuetify application. It sets up a base template with all the necessary configurations and standard directory structure, enabling you to begin development without the hassle of setting up the project from scratch.
- 📄 Docs
- 🚨 Issues
- 🏬 Store
- 🎮 Playground
- 💬 Discord
Set up your project using your preferred package manager. Use the corresponding command to install the dependencies:
| Package Manager | Command |
|---|---|
| yarn | yarn install |
| npm | npm install |
| pnpm | pnpm install |
| bun | bun install |
After completing the installation, your environment is ready for Vuetify development.
- 🖼️ Optimized Front-End Stack: Leverage the latest Vue 3 and Vuetify 3 for a modern, reactive UI development experience. Vue 3 | Vuetify 3
- 🗃️ State Management: Integrated with Pinia, the intuitive, modular state management solution for Vue.
- 🚦 Routing and Layouts: Utilizes Vue Router for SPA navigation and vite-plugin-vue-layouts for organizing Vue file layouts. Vue Router | vite-plugin-vue-layouts
- ⚡ Next-Gen Tooling: Powered by Vite, experience fast cold starts and instant HMR (Hot Module Replacement). Vite
- 🧩 Automated Component Importing: Streamline your workflow with unplugin-vue-components, automatically importing components as you use them. unplugin-vue-components
These features are curated to provide a seamless development experience from setup to deployment, ensuring that your Vuetify application is both powerful and maintainable.
This section covers how to start the development server and build your project for production.
To start the development server with hot-reload, run the following command. The server will be accessible at http://localhost:3000:
yarn dev(Repeat for npm, pnpm, and bun with respective commands.)
Add NODE_OPTIONS='--no-warnings' to suppress the JSON import warnings that happen as part of the Vuetify import mapping. If you are on Node v21.3.0 or higher, you can change this to NODE_OPTIONS='--disable-warning=5401'. If you don't mind the warning, you can remove this from your package.json dev script.
To build your project for production, use:
yarn build(Repeat for npm, pnpm, and bun with respective commands.)
Once the build process is completed, your application will be ready for deployment in a production environment.
This project is built with Vuetify, a UI Library with a comprehensive collection of Vue components. Vuetify is an MIT licensed Open Source project that has been made possible due to the generous contributions by our sponsors and backers. If you are interested in supporting this project, please consider:
- Requesting Enterprise Support
- Sponsoring John on Github
- Sponsoring Kael on Github
- Supporting the team on Open Collective
- Becoming a sponsor on Patreon
- Becoming a subscriber on Tidelift
- Making a one-time donation with Paypal
This project is configured with GitHub Actions to automatically deploy to GitHub Pages whenever changes are pushed to the main branch.
The deployment happens automatically when:
- Code is pushed to the
mainbranch - Pull requests are opened (for testing the workflow)
- The GitHub Actions workflow builds the project with the correct base URL for your repository
- The built files are deployed to GitHub Pages
If you need to deploy manually or configure the base URL differently:
# Build for GitHub Pages with custom base URL
NODE_ENV=production VITE_BASE_URL=/your-repo-name/ npm run buildThe base URL is automatically set based on your repository name during GitHub Actions deployment, so no manual configuration is required for most use cases.
To enable GitHub Pages:
- Go to your repository's Settings
- Navigate to Pages in the left sidebar
- Under "Source", select "GitHub Actions"
- The site will be available at
https://yourusername.github.io/your-repo-name/
Copyright (c) 2016-present Vuetify, LLC