From 55b49a69cf2267eb39b2b506aed5a93b51d5d528 Mon Sep 17 00:00:00 2001 From: odc.xiaohui <xiaohui@Q1> Date: 星期四, 29 二月 2024 13:51:14 +0800 Subject: [PATCH] Merge remote-tracking branch 'origin/master' --- README.md | 126 ------------------------------------------ 1 files changed, 0 insertions(+), 126 deletions(-) diff --git a/README.md b/README.md index eb858a8..e69de29 100644 --- a/README.md +++ b/README.md @@ -1,126 +0,0 @@ -<div align='center'> -<h1>Vite-Boot </h1> -<img src='README.assets/logo.png' alt='Vite-Boot - Opinionated Vite Starter Template' width='344'/> -</div> - -<p align='center'> -Mocking up web app with <b>Vite-Boot </b><sup><em>(speed)</em></sup><br> -</p> - -<div align='center'> -<b>English</b> | <a href="README.zh-CN.md">绠�浣撲腑鏂�</a> -</div> - -## Features - -- 鈿� [Vue 3](https://github.com/vuejs/vue-next), [Vite 2](https://github.com/vitejs/vite), [pnpm](https://pnpm.js.org/) - born with fastness -- 馃挭 [Typescript](https://www.typescriptlang.org/) - of course! necessary -- 馃敟 Use the [new `<script setup>` syntax](https://github.com/vuejs/rfcs/pull/227) -- 馃馃徎 [Reactivity Transform](https://vuejs.org/guide/extras/reactivity-transform.html) enabled -- 馃摝 [Components auto importing](./src/components) -- 馃摜 [APIs auto importing](https://github.com/antfu/unplugin-auto-import) - use Composition API and others directly -- 馃挕 [Vue Router v4](https://router.vuejs.org/zh/) - The official router for Vue.js -- 馃帹 [Tailwind CSS v3](https://tailwindcss.com/docs/configuration) - Rapidly build modern websites without ever leaving your HTML. -- 馃帀 [NProgress](https://github.com/rstacruz/nprogress) - Page loading progress feedback -- 馃崓 [State Management via Pinia](https://pinia.esm.dev/) - The Vue Store that you will enjoy using -- 馃尲 [Daisy](https://daisyui.com/) - The free and open-source Tailwind CSS component library - -### First-party plugins needed for Tailwind UI: - -- [tailwindcss/forms](https://github.com/tailwindlabs/tailwindcss-forms) -- [tailwindcss/typography](https://tailwindcss.com/docs/typography-plugin) -- [tailwindcss/line-clamp](https://github.com/tailwindlabs/tailwindcss-line-clamp) -- [tailwindcss/aspect-ratio](https://github.com/tailwindlabs/tailwindcss-aspect-ratio) - -### Coding Style - -- [@kirklin/eslint-config](https://github.com/kirklin/eslint-config) - -### Recommended IDE Setup - -- [VSCode](https://code.visualstudio.com/) -- [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) - -### Performance -<img src='README.assets/ViteBoot-Lighthouse.png' alt='Vite-Boot Outstanding performance' width='1851'/> - - -## directory - -``` -# vite-boot -鈹溾攢鈹� LICENSE -鈹溾攢鈹� README.assets -鈹� 鈹斺攢鈹� vite-vue-tailwind.png -鈹溾攢鈹� README.md -鈹溾攢鈹� README.zh-CN.md -鈹溾攢鈹� index.html -鈹溾攢鈹� node_modules -鈹溾攢鈹� package.json -鈹溾攢鈹� pnpm-lock.yaml -鈹溾攢鈹� postcss.config.js # tailwind configuration -鈹溾攢鈹� public -鈹� 鈹斺攢鈹� favicon.ico -鈹溾攢鈹� src -鈹� 鈹溾攢鈹� App.vue -鈹� 鈹溾攢鈹� api # api interface -鈹� 鈹溾攢鈹� assets # static resource -鈹� 鈹� 鈹斺攢鈹� logo.png -鈹� 鈹溾攢鈹� components # global component -鈹� 鈹� 鈹斺攢鈹� Navbar.vue # Navbar component -鈹� 鈹溾攢鈹� env.d.ts -鈹� 鈹溾攢鈹� main.ts -鈹� 鈹溾攢鈹� router # Vue router -鈹� 鈹� 鈹斺攢鈹� index.ts -鈹� 鈹溾攢鈹� settings.ts # global configuration -鈹� 鈹溾攢鈹� store # Pinia store -鈹� 鈹� 鈹溾攢鈹� counter.ts -鈹� 鈹� 鈹斺攢鈹� index.ts -鈹� 鈹溾攢鈹� styles # global style -鈹� 鈹� 鈹溾攢鈹� main.scss -鈹� 鈹� 鈹溾攢鈹� nprogress.scss # nprogress style -鈹� 鈹� 鈹溾攢鈹� tailwind.css -鈹� 鈹� 鈹斺攢鈹� variables.scss -鈹� 鈹溾攢鈹� utils # global public method -鈹� 鈹� 鈹斺攢鈹� darkMode.ts -鈹� 鈹斺攢鈹� views # all pages -鈹� 鈹斺攢鈹� Index.vue -鈹溾攢鈹� tailwind.config.js # tailwind configuration -鈹溾攢鈹� tsconfig.json # TS compilation configuration -鈹斺攢鈹� vite.config.ts # Vite configuration - -``` - -## Try it now! - -### GitHub Template - -[Create a repo from this template on GitHub](https://github.com/kirklin/vite-boot/generate). - -### Clone to local - -```bash -npx degit kirklin/vite-boot my-vite-app -cd my-vite-app -pnpm i -``` - -## Usage - -### Development - -Just run and visit http://localhost:8888 - -```bash -pnpm run dev -``` - -### Build - -To build the App, run - -```bash -pnpm run build -``` - -And you will see the generated file in `dist` that ready to be served. -- Gitblit v1.8.0