# vite-vue3-template

**Repository Path**: aguwang/vite-vue3-template

## Basic Information

- **Project Name**: vite-vue3-template
- **Description**: Vite+Vue3+Pinia+TS+Sass+Element+Axios Template
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-02
- **Last Updated**: 2024-03-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: vite, vue3, Pinia, Sass, Element-UI

## README

# Vite5.x + Vue 3.x + Typescript

[preview](https://vite.vue3.sugarat.top/)
## Features
### PROD
* [x] [Vue3](https://vuejs.org/)
* [x] [Pinia](https://pinia.vuejs.org/) - replace vuex
* [x] [Vue-Router](https://router.vuejs.org/)
* [x] [Axios](https://github.com/axios/axios)
* [x] [Provide/inject](https://vuejs.org/guide/components/provide-inject.html#provide-inject)
* [x] [polyfill.io](https://github.com/JakeChampion/polyfill-service)
* [x] [Element UI Plus](https://github.com/element-plus/element-plus)
* [x] [VueUse](https://vueuse.org/)

### DEV
* [x] [PNPM 8](https://pnpm.io/zh/cli/run)
* [x] [Vite 5](https://github.com/vitejs/vite)
* [x] [TypeScript 5](https://github.com/microsoft/TypeScript/#readme)
* [x] [Sass](https://github.com/sass/sass)
* [x] [Eslint 8](https://eslint.org/) + [@antfu/eslint-config](https://github.com/antfu/eslint-config)
* [x] [Vitest 1.0](https://vitest.dev/) - unit testing
* [x] [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks#readme) - Git Hooks
* [x] [commitlint](https://commitlint.js.org/#/) - - commit message lint

## Use This Template
```sh
npx degit atqq/vite-vue3-template#main my-project
```
or

Visit：[https://github.com/ATQQ/vite-vue3-template/generate](https://github.com/ATQQ/vite-vue3-template/generate)
## Usage
**建议使用 >= Node v18**

![](https://img.cdn.sugarat.top/mdImg/MTY4NTU0MjM3NTI1Mw==685542375253)

### install dep
need install pnpm
```sh
# pnpm8
npm i -g pnpm
```

```sh
pnpm install
```

### Dev
```sh
pnpm dev
```

### Build
```sh
pnpm build
```

### Preview Build
```sh
pnpm preview
```