# Vuetify (Default) 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. ## ❗️ Important Links - 📄 [Docs](https://vuetifyjs.com/) - 🚨 [Issues](https://issues.vuetifyjs.com/) - 🏬 [Store](https://store.vuetifyjs.com/) - 🎮 [Playground](https://play.vuetifyjs.com/) - 💬 [Discord](https://community.vuetifyjs.com) ## 💿 Install Set up your project using your preferred package manager. Use the corresponding command to install the dependencies: | Package Manager | Command | |---------------------------------------------------------------|----------------| | [yarn](https://yarnpkg.com/getting-started) | `yarn install` | | [npm](https://docs.npmjs.com/cli/v7/commands/npm-install) | `npm install` | | [pnpm](https://pnpm.io/installation) | `pnpm install` | | [bun](https://bun.sh/#getting-started) | `bun install` | After completing the installation, your environment is ready for Vuetify development. ## ✨ Features - 🖼️ **Optimized Front-End Stack**: Leverage the latest Vue 3 and Vuetify 3 for a modern, reactive UI development experience. [Vue 3](https://v3.vuejs.org/) | [Vuetify 3](https://vuetifyjs.com/en/) - 🗃️ **State Management**: Integrated with [Pinia](https://pinia.vuejs.org/), 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](https://router.vuejs.org/) | [vite-plugin-vue-layouts](https://github.com/JohnCampionJr/vite-plugin-vue-layouts) - 💻 **Enhanced Development Experience**: Benefit from TypeScript's static type checking and the ESLint plugin suite for Vue, ensuring code quality and consistency. [TypeScript](https://www.typescriptlang.org/) | [ESLint Plugin Vue](https://eslint.vuejs.org/) - ⚡ **Next-Gen Tooling**: Powered by Vite, experience fast cold starts and instant HMR (Hot Module Replacement). [Vite](https://vitejs.dev/) - 🧩 **Automated Component Importing**: Streamline your workflow with unplugin-vue-components, automatically importing components as you use them. [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) - 🛠️ **Strongly-Typed Vue**: Use vue-tsc for type-checking your Vue components, and enjoy a robust development experience. [vue-tsc](https://github.com/johnsoncodehk/volar/tree/master/packages/vue-tsc) These features are curated to provide a seamless development experience from setup to deployment, ensuring that your Vuetify application is both powerful and maintainable. ## 💡 Usage This section covers how to start the development server and build your project for production. ### Starting the Development Server To start the development server with hot-reload, run the following command. The server will be accessible at [http://localhost:3000](http://localhost:3000): ```bash yarn dev ``` (Repeat for npm, pnpm, and bun with respective commands.) ### Building for Production To build your project for production, use: ```bash 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. ## 💪 Support Vuetify Development This project is built with [Vuetify](https://vuetifyjs.com/en/), 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](https://vuetifyjs.com/introduction/sponsors-and-backers/). If you are interested in supporting this project, please consider: - [Requesting Enterprise Support](https://support.vuetifyjs.com/) - [Sponsoring John on Github](https://github.com/users/johnleider/sponsorship) - [Sponsoring Kael on Github](https://github.com/users/kaelwd/sponsorship) - [Supporting the team on Open Collective](https://opencollective.com/vuetify) - [Becoming a sponsor on Patreon](https://www.patreon.com/vuetify) - [Becoming a subscriber on Tidelift](https://tidelift.com/subscription/npm/vuetify) - [Making a one-time donation with Paypal](https://paypal.me/vuetify) ## 📑 License [MIT](http://opensource.org/licenses/MIT) Copyright (c) 2016-present Vuetify, LLC