Files
ChopperBot/console-ui/README.md
2023-04-20 01:41:52 +08:00

120 lines
4.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<br><br>
<p align='center' >
<img src='/src/assets/logo_light.svg' alt='Vuetify3' width='300'/>
</p>
<br><br>
<p align="center">
<a href="https://vuejs.org/">
<img src="https://img.shields.io/badge/vue-v3.2.47-brightgreen.svg" alt="vue">
</a>
<a href="https://vuetifyjs.com/">
<img src="https://img.shields.io/badge/vuetify-v3.1.13-blue.svg" alt="element-ui">
</a>
<a href="https://vitejs.dev/">
<img src="https://img.shields.io/badge/vite-v4.2.1-blueviolet.svg" alt="element-ui">
</a>
<a href="https://github.com/yangjiakai/lux-admin-vuetify3/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/mashape/apistatus.svg" alt="license">
</a>
</p>
<h4 align='center'>
<a href="https://lux.vuetify3.com/">Live Demo</a>
</h4>
<br>
<p align='center'>
<b>English</b> | <a href="https://github.com/yangjiakai/jk-vuetify3-lux-admin/blob/main/README.zh-CN.md">简体中文</a>| <a href="https://github.com/yangjiakai/jk-vuetify3-lux-admin/blob/main/README.jp.md">日本語</a>
</p>
## Introduction
> Goal: Creating the best Vuetify 3 Admin open-source template.
Built upon the elegant themes of Vuetify, we have established a clear and efficient project structure, integrating the latest technology frameworks. This project aims to address a wide range of common technical requirements and features, while incorporating an AI assistant for a more intelligent experience. Additionally, we ensure that all pages are adaptive across multiple devices, achieving a seamless cross-platform compatibility.
## Features
- 📖 [Vue 3.2](https://github.com/vuejs/core)
- 📖 [Vite 4.x](https://github.com/vitejs/vite)
- 📖 UI Framework [Vuetify 3](https://next.vuetifyjs.com/en/)
- 📖 TypeScript
- 📦 Component Auto Importing
- 🍍 [Pinia](https://pinia.vuejs.org/)
- 📔 `<script setup>`
- 📚 Use icons from any icon sets in [Iconify](https://icon-sets.iconify.design/)
- ☁️ Deploy on Netlify, zero-config
- 🔑 Firebase auth
- 📈 Echarts, ApexChart
- 🧭 Openai, Chatgpt
- 🌍 vue-i18n
- 📚 virtual-scroller , vuedraggable , perfect-scrollbar
- 📝 Rich Text Editor
- 📇 Responsive multi-platform adaptive
## Contact Me
- Email <a href="mailto:yjkbako@gmail.com">yjkbako@gmail.com</a>
- Twitter https://twitter.com/baibaixiang
- Wechat <img src='/src/assets/wechat-qrcode.png' alt='DashBoard' width='300' />
## Preview
<img src='/src/assets/previews/DashBoard.png' alt='DashBoard' />
<img src='/src/assets/previews/TaskBoard.png' alt='ChatGPT' />
<img src='/src/assets/previews/DataTable.png' alt='DataTable' />
<img src='/src/assets/previews/Todo.png' alt='ChatGPT' />
<img src='/src/assets/previews/ChatGPT.png' alt='ChatGPT' />
<img src='/src/assets/previews/Card.png' alt='Card' />
<img src='/src/assets/previews/Color.png' alt='Color' />
<img src='/src/assets/previews/Gradient.png' alt='Gradient' />
<img src='/src/assets/previews/Login.png' alt='ChatGPT' />
<img src='/src/assets/previews/Unsplash.png' alt='ChatGPT' />
<img src='/src/assets/previews/Unsplash2.png' alt='ChatGPT' />
<br>
## Pre-packed
### UI Frameworks
- [Vuetify3](https://next.vuetifyjs.com/en/) - Vuetify is a no design skills required UI Framework with beautifully handcrafted Vue Components.
### Icons
- [Iconify](https://iconify.design) - use icons from any icon sets [🔍Icônes](https://icones.netlify.app/)
- [Pure CSS Icons via UnoCSS](https://github.com/antfu/unocss/tree/main/packages/preset-icons)
### Plugins
- [Vue Router4](https://router.vuejs.org/)
- [VueUse](https://github.com/antfu/vueuse) - collection of useful composition APIs
- [VuedDaggable](https://github.com/SortableJS/Vue.Draggable) - allowing drag-and-drop and synchronization with view model array.
- [Vue-Masonry-Wall](https://github.com/DerYeger/yeger/tree/main/packages/vue-masonry-wall) - Responsive masonry layout with SSR support and zero dependencies for Vue 3.
- [Vue-Virtual-Scroller](https://github.com/Akryum/vue-virtual-scroller) - Blazing fast scrolling of any amount of data
## Try it now!
```
git clone https://github.com/yangjiakai/lux-admin-vuetify3.git
cd lux-admin-vuetify3
npm install
npm run dev
```
### Set ApiKey
Find the `.env.template` file in the root directory, remove the `.template` suffix, and replace` VITE_OPENAI_API_KEY`, `VITE_UNSPLASH_ACCESS_KEY`, and `VITE_GITHUB_CLIENT_ID` with your own keys.
> openai apikey https://platform.openai.com/account/api-keys
> unsplash apikey https://unsplash.com/oauth/applications
> github apikey https://github.com/settings/tokens