Overview
The vite-vue-box
is a Vue 3 business framework that allows you to quickly generate a modern, fast, and efficient Vue application. It leverages the latest technologies such as Vite, pnpm, ESBuild, and Pinia to provide a seamless development experience. With features like components auto-importing, TailwindCSS integration, and support for the new <script setup>
syntax, vite-vue-box
offers a powerful and convenient way to build modern websites. The template also includes necessary tools like TypeScript, eslint, stylelint, and commitlint to ensure code quality and maintainability.
Features
- Vue 3, Vite 3, pnpm, and ESBuild: Built with the latest and fastest technologies for optimal performance.
- Components Auto Importing: Automatically imports components, making development more efficient.
- State Management via Pinia: Offers a state management solution using the Pinia library.
- TailwindCSS: Seamlessly integrates TailwindCSS, allowing for rapid development of modern websites.
- New
<script setup>
Syntax: Takes advantage of the new<script setup>
syntax in Vue 3 for cleaner and more concise component definitions. - Vue-hooks-plus: Includes the vue-hooks-plus library, which provides various hooks to handle common business logic.
- Axios: Bundles the complete business request process with the vue-hooks-plus/useRequest hook.
- APIs Auto Importing: Allows for the direct use of Composition API and other APIs.
- TypeScript: Includes TypeScript support for improved developer experience and type safety.
- Eslint, Stylelint, Commitlint, and Husky: Provides normative constraints and linting to enhance code quality.
Installation
To use the vite-vue-box
template, follow these steps:
- Create a new repository on GitHub using this template.
- Clone the newly created repository to your local machine.
- Update the following information:
- Change the author name in the
LICENSE
file. - Change the title in the
App.vue
file. - Change the hostname in the
vite.config.ts
andconfig
files. - Change the favicon in the
public
folder. - Remove the
.github
folder which contains the funding info. - Clean up the READMEs and remove unnecessary routes.
- Change the author name in the
Summary
The vite-vue-box
is a powerful Vue 3 business framework that provides a fast and efficient development setup. With its integration of the latest technologies, components auto-importing, state management via Pinia, TailwindCSS support, and the new <script setup>
syntax, vite-vue-box
offers an excellent solution for building modern Vue applications. The template also includes necessary tools like TypeScript, linting, and commit conventions to ensure code quality and maintainability. By following the simple installation steps provided, developers can quickly start building their Vue projects with ease.