Template
first commit
This commit is contained in:
@@ -0,0 +1,238 @@
|
||||
<div align="center">
|
||||
<img alt="logo" width="120" height="120" src="./src/common/assets/images/layouts/logo.png">
|
||||
<h1>V3 Admin Vite - AI Friendly</h1>
|
||||
</div>
|
||||
|
||||
[](https://github.com/un-pany/v3-admin-vite/releases)
|
||||
[](https://github.com/un-pany/v3-admin-vite/stargazers)
|
||||
[](https://gitee.com/un-pany/v3-admin-vite/stargazers)
|
||||
[](https://atomgit.com/un-pany/v3-admin-vite/stargazers)
|
||||
|
||||
<b>English | <a href="./README.zh-CN.md">中文</a></b>
|
||||
|
||||
## Introduction <a href="https://juejin.cn/post/7660780385584316454"><img src="https://img.shields.io/badge/AI-Coding-black" alt="AI Coding"></a>
|
||||
|
||||
V3 Admin Vite is an AI-friendly admin dashboard template built on mainstream technologies such as Vue3, Vite, TypeScript, and Element Plus, offering an excellent "Vibe Coding" experience!
|
||||
|
||||
_Supports mainstream AI coding tools such as Claude Code, CodeX, Cursor, Trae, and Antigravity_
|
||||
|
||||
## Notifications
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Welcome to the all-new version 5.2, delivering a unique AI coding experience! It also introduces the long-awaited backend-controlled dynamic routing permission system
|
||||
|
||||
> [!WARNING]
|
||||
> Version 4.x will no longer be maintained unless there are critical bugs! [Click to switch to the 4.x branch](https://github.com/un-pany/v3-admin-vite/tree/4.x)
|
||||
|
||||
> [!TIP]
|
||||
> Paid services are officially launched! If you don’t want to do it yourself but want to remove TS or other modules, try the lazy package! [Click to check it out](https://github.com/un-pany/v3-admin-vite/issues/225)
|
||||
|
||||
> [!NOTE]
|
||||
> If you have mobile web app requirements, give the new open-source template [MobVue](https://github.com/un-pany/mobvue) a try
|
||||
|
||||
## Usage
|
||||
|
||||
<details>
|
||||
<summary>Recommended Environment</summary>
|
||||
|
||||
<br>
|
||||
|
||||
- Latest version of `Visual Studio Code` or AI IDE `Cursor` and `Trae`
|
||||
- Install the recommended plugins in the `.vscode/extensions.json` file
|
||||
- `node` 20.19+ or 22.12+
|
||||
- `pnpm` 10+
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Local Development</summary>
|
||||
|
||||
<br>
|
||||
|
||||
```bash
|
||||
# Clone the project
|
||||
git clone https://github.com/un-pany/v3-admin-vite.git
|
||||
|
||||
# Enter the project directory
|
||||
cd v3-admin-vite
|
||||
|
||||
# Install dependencies
|
||||
pnpm i
|
||||
|
||||
# Start the development server
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Build</summary>
|
||||
|
||||
<br>
|
||||
|
||||
```bash
|
||||
# Build for the staging environment
|
||||
pnpm build:staging
|
||||
|
||||
# Build for the production environment
|
||||
pnpm build
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Local Preview</summary>
|
||||
|
||||
<br>
|
||||
|
||||
```bash
|
||||
# Execute the build command first to generate the dist directory, then run the preview command
|
||||
pnpm preview
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Code Check</summary>
|
||||
|
||||
<br>
|
||||
|
||||
```bash
|
||||
# Code linting and formatting
|
||||
pnpm lint
|
||||
|
||||
# Unit tests
|
||||
pnpm test
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Commit Guidelines</summary>
|
||||
|
||||
<br>
|
||||
|
||||
`feat` New feature
|
||||
|
||||
`fix` Bug fix
|
||||
|
||||
`perf` Performance improvement
|
||||
|
||||
`refactor` Code refactoring
|
||||
|
||||
`docs` Documentation and comments
|
||||
|
||||
`types` Type-related changes
|
||||
|
||||
`test` Unit tests related
|
||||
|
||||
`ci` Continuous integration, workflows
|
||||
|
||||
`revert` Revert changes
|
||||
|
||||
`chore` Chores (update dependencies, modify configurations, etc)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Install recommended skills</summary>
|
||||
|
||||
<br>
|
||||
|
||||
```bash
|
||||
npx skills experimental_install
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Links
|
||||
|
||||
**Online Preview**: [github-pages](https://un-pany.github.io/v3-admin-vite)
|
||||
|
||||
**Chinese Documentation**: [link](https://juejin.cn/post/7445151895121543209)
|
||||
|
||||
**Zero to Hero Tutorial**: [link](https://juejin.cn/column/7207659644487139387)
|
||||
|
||||
**Mobile Web App**: [mobvue](https://github.com/un-pany/mobvue)
|
||||
|
||||
**Electron Desktop Version**: [v3-electron-vite](https://github.com/un-pany/v3-electron-vite)
|
||||
|
||||
**Chinese Repository**: [gitee](https://gitee.com/un-pany/v3-admin-vite), [atomgit](https://atomgit.com/un-pany/v3-admin-vite)
|
||||
|
||||
**Optional Group**: [check how to join](https://github.com/un-pany/v3-admin-vite/issues/191)
|
||||
|
||||
**Donations**: [buy a coffee for the author](https://github.com/un-pany/v3-admin-vite/issues/69)
|
||||
|
||||
**Releases & Changelog**: [releases](https://github.com/un-pany/v3-admin-vite/releases)
|
||||
|
||||
## Features
|
||||
|
||||
**Simplified structure**: No complex encapsulation, no complicated type gymnastics, just enough to meet the needs
|
||||
|
||||
**Detailed comments**: Every configuration item comes with as detailed comments as possible
|
||||
|
||||
**Latest dependencies**: Keeps all third-party dependencies up to date
|
||||
|
||||
**Consistency**: Unified code style, naming conventions, and comment style
|
||||
|
||||
## Built-in Features
|
||||
|
||||
**User Management**: Login, logout demonstration
|
||||
|
||||
**Permission Management**: Page-level permissions (dynamic routing controlled by backend APIs), button-level permissions (permission directives and functions), and route guards
|
||||
|
||||
**Multiple Environments**: Development, staging, and production environments
|
||||
|
||||
**Multiple Themes**: Normal, dark, and deep blue themes
|
||||
|
||||
**Multiple Layouts**: Left-side, top, and hybrid layouts
|
||||
|
||||
**Homepage**: Different dashboard pages for different users
|
||||
|
||||
**Error Pages**: 403, 404
|
||||
|
||||
**Mobile Compatibility**: Layouts compatible with mobile screen resolutions
|
||||
|
||||
**Others**: SVG sprite sheet, dynamic sidebar, dynamic breadcrumbs, tab navigation, content zoom and fullscreen, composable functions
|
||||
|
||||
## Tech Stack
|
||||
|
||||
**Vue3**: Vue3 + script setup with the latest Vue3 Composition API
|
||||
|
||||
**Element Plus**: The Vue3 version of Element UI
|
||||
|
||||
**Pinia**: The legendary Vuex5
|
||||
|
||||
**Vite**: Really fast
|
||||
|
||||
**Vue Router**: The routing system
|
||||
|
||||
**TypeScript**: A superset of JavaScript
|
||||
|
||||
**pnpm**: A faster, disk-space-saving package manager
|
||||
|
||||
**Scss**: Consistent with Element Plus
|
||||
|
||||
**CSS Variables**: Primarily controls layout and color in the project
|
||||
|
||||
**ESLint**: Code linting and formatting
|
||||
|
||||
**Axios**: Sends network requests
|
||||
|
||||
**UnoCSS**: A high-performance, flexible atomic CSS engine
|
||||
|
||||
## Project Preview Image
|
||||
|
||||
|
||||
|
||||
## Contributors
|
||||
|
||||
A big thank you to all the contributors!
|
||||
|
||||
<a href="https://github.com/un-pany/v3-admin-vite/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=un-pany/v3-admin-vite" alt="contributors">
|
||||
</a>
|
||||
|
||||
## License
|
||||
|
||||
[MIT](./LICENSE) License © 2022-PRESENT [pany](https://github.com/pany-ang)
|
||||
Reference in New Issue
Block a user