https://github.com/ljt990218/vue3-naiveui-pc
An PC template based on the Vue 3 ecosystem. 一个基于 Vue 3 生态系统的PC模板，帮助你快速完成业务开发。
https://github.com/ljt990218/vue3-naiveui-pc
naive-ui pc template typescript vite-template vue3 vue3-template vuejs
Last synced: 6 months ago
JSON representation
An PC template based on the Vue 3 ecosystem. 一个基于 Vue 3 生态系统的PC模板，帮助你快速完成业务开发。
- Host: GitHub
- URL: https://github.com/ljt990218/vue3-naiveui-pc
- Owner: ljt990218
- License: mit
- Created: 2024-05-27T08:32:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-29T06:42:13.000Z (over 1 year ago)
- Last Synced: 2025-04-01T20:01:43.353Z (6 months ago)
- Topics: naive-ui, pc, template, typescript, vite-template, vue3, vue3-template, vuejs
- Language: TypeScript
- Homepage: https://vue3-naiveui-pc.netlify.app/
- Size: 154 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
vue3-naiveui-pc
English / [简体中文](./README.zh-CN.md)
An PC template based on the Vue 3 ecosystem.
一个基于 Vue 3 生态系统的PC模板，帮助你快速完成业务开发。
[](https://app.netlify.com/sites/vue3-naiveui-pc/deploys)
## Features
- ⚡️ [Vue 3](https://github.com/vuejs/core), [Vite 5](https://github.com/vitejs/vite), [pnpm](https://pnpm.io/), [esbuild](https://github.com/evanw/esbuild) - born with fastness
- 🗂 [File based routing](./src/router)
- 📦 [Components auto importing](./src/components)
- 🍍 [State Management via Pinia](https://pinia.vuejs.org)
- 📲 [PWA](https://github.com/antfu/vite-plugin-pwa)
- 🎨 [UnoCSS](https://github.com/antfu/unocss) - the instant on-demand atomic CSS engine
- 🌍 [I18n ready](./src/locales)
- 🔥 Use the [new `` syntax](https://github.com/vuejs/rfcs/pull/227)
- 📥 [APIs auto importing](https://github.com/antfu/unplugin-auto-import) - use Composition API and others directly
- 💪 TypeScript, of course
- ⚙️ Unit Testing with [Vitest](https://github.com/vitest-dev/vitest)
- 💾 [Mock](https://github.com/pengzhanbo/vite-plugin-mock-dev-server) server Support
- 🌈 Git [hooks](./.husky) - lint and commit
- 🪶 [Naive Ui](https://github.com/tusen-ai/naive-ui) - PC Vue component library
- 🔭 [vConsole](https://github.com/vadxq/vite-plugin-vconsole) - the developer tool for mobile web page
- 🌓 Dark Mode Support
- 🛡️ Configure [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) as default
- ☁️ Deploy on [Netlify](https://www.netlify.com), zero-config
<br>
## Pre-packed
### UI Frameworks
- [UnoCSS](https://github.com/antfu/unocss) - The instant on-demand atomic CSS engine
- [`@unocss/preset-rem-to-px`](https://github.com/unocss/unocss/tree/main/packages/preset-rem-to-px) - Converts rem to px for all utilities
- [`eslint-plugin-unocss`](https://github.com/devunt/eslint-plugin-unocss) - ESLint plugin for UnoCSS
- 🪶 [Naive Ui](https://github.com/tusen-ai/naive-ui) - PC Vue component library
### Plugins
- [Vue Router](https://github.com/vuejs/router)
- [`unplugin-vue-router`](https://github.com/posva/unplugin-vue-router) - file system based routing
- [Pinia](https://pinia.vuejs.org) - Intuitive, type safe, light and flexible Store for Vue using the composition api
- [`pinia-plugin-persistedstate`](https://github.com/prazdevs/pinia-plugin-persistedstate) - Configurable persistence and rehydration of Pinia stores
- [Vue I18n](https://github.com/intlify/vue-i18n-next) - Internationalization
- [`unplugin-vue-i18n`](https://github.com/intlify/bundle-tools/tree/main/packages/unplugin-vue-i18n) - unplugin for Vue I18n
- [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) - components auto import
- [unplugin-auto-import](https://github.com/antfu/unplugin-auto-import) - Directly use Vue Composition API and others without importing
- [vite-plugin-vconsole](https://github.com/vadxq/vite-plugin-vconsole) - A lightweight, extendable front-end developer tool for mobile web page
- [vite-plugin-mock-dev-server](https://github.com/pengzhanbo/vite-plugin-mock-dev-server) - Vite Plugin for API mock dev server
- [vite-plugin-vue-devtools](https://github.com/vuejs/devtools-next) - Designed to enhance the Vue developer experience
- [vueuse](https://github.com/antfu/vueuse) - collection of useful composition APIs
- [@unhead/vue](https://github.com/unjs/unhead) - manipulate document head reactively
- [vite-plugin-pwa](https://github.com/antfu/vite-plugin-pwa) - PWA
- [vite-plugin-sitemap](https://github.com/jbaubree/vite-plugin-sitemap) - sitemap and robots generator
### Coding Style
- Use Composition API with [`<script setup>` SFC syntax](https://github.com/vuejs/rfcs/pull/227)
- [ESLint](https://eslint.org/) with [@antfu/eslint-config](https://github.com/antfu/eslint-config), single quotes, no semi
### Dev tools
- [TypeScript](https://www.typescriptlang.org/)
- [Vitest](https://github.com/vitest-dev/vitest) - Unit testing powered by Vite
- [pnpm](https://pnpm.js.org/) - fast, disk space efficient package manager
- [Netlify](https://www.netlify.com/) - zero-config deployment
- [VS Code Extensions](./.vscode/extensions.json)
- [Vite](https://marketplace.visualstudio.com/items?itemName=antfu.vite) - Fire up Vite server automatically
- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) - Vue 3 `<script setup>` IDE support
- [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify) - Icon inline display and autocomplete
- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) - All in one i18n support
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
## Try it now
> vue3-naiveui-pc requires Node 18+
### GitHub Template
[Create a repo from this template on GitHub](https://github.com/ljt990218/vue3-naiveui-pc/generate)
### Clone to local
If you prefer to do it manually with the cleaner git history
```bash
npx degit ljt990218/vue3-naiveui-pc my-mobile-app
cd my-mobile-app
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
```
## Checklist
When you use this template, try follow the checklist to update your info properly
- [ ] Change the author name in `LICENSE`
- [ ] Change the title in `index.html`
- [ ] Change the hostname in `vite.config.ts`
- [ ] Change the favicon in `public`
- [ ] Clean up the READMEs and remove routes
And, enjoy :)
## Usage
### Development
Just run and visit <http://localhost:3000>
```bash
pnpm dev
```
### Build
To build the App, run
```bash
pnpm build
```
And you will see the generated file in `dist` that ready to be served.
### Deploy on Netlify
Go to [Netlify](https://app.netlify.com/start) and select your clone, `OK` along the way, and your App will be live in a minute.
## Community
We recommend that [issue](https://github.com/ljt990218/vue3-naiveui-pc/issues).
## License
[MIT](./LICENSE) License