Skip to content

Lirous587/vue-scaffold

Repository files navigation

vue-scaffold 极简手脚架

本项目为自用极简 Vue3 + Vite + Pinia + TailwindCSS 后台管理系统脚手架 (当然也可以用于做无需SRR的C端系统等)

推荐使用 pnpm gonew 脚本一键重置,快速获得干净的起步环境


✨ 特性

  • 基于 Vue 3VitePiniaTailwindCSS
  • 已集成 TypeScript、ESLint、Prettier、Husky、lint-staged 等开发工具
  • 支持一键重置,快速清理模板内容
  • 目录结构清晰,方便二次开发
  • 常用依赖预装:axios、nprogress、li-daisy、daisyui、md-editor-v3、cropperjs 等

📦 依赖

  • 核心依赖
    • vue vue-router pinia
    • tailwindcss daisyui li-daisy
    • axios nprogress md-editor-v3 cropperjs uuid universal-cookie yup

如果使用了 pnpm gonew 那将仅需保留以下核心依赖

  • vue vue-router pinia
  • tailwindcss
  • axios

若执意需要一个完全干净的手脚架可以删除非必要依赖

注意 li-daisy 为作者自主开发的组件库,目的是完善 daisyui 中不足的功能,若无使用兴趣,请删除 assets/css 下的 tailwind.css 中的这两行

@plugin "daisyui";
@import './daisyui.css';

以及删除其下的 daisyui.css 这一文件


📁 目录结构

src/
  ├─ api/
  ├─ assets/
  ├─ components/
  ├─ composable/
  ├─ layouts/
  ├─ pages/
  ├─ request/
  ├─ scripts/
  ├─ stores/
  ├─ utils/
  ├─ App.vue
  ├─ config.ts
  ├─ main.ts
  └─ routerGuards.ts (执行gonew脚本之后将被删除)

🚀 快速开始

  1. 新建目录

    mkdir demo
    cd demo
  2. 克隆项目

    git clone https://github.com/Lirous587/vue-scaffold.git
  3. 移动目录 并删除git记录

    robocopy vue-scaffold . /E /XD .git
  4. 删除clone目录

    Remove-Item vue-scaffold -Recurse -Force
  5. 安装依赖

    pnpm i
  6. 重置项目

    若不希望有任何杂七杂八的内容,可以执行脚本 pnpm gonew

    这将仅仅保留项目基础结构以及基础 css 文件

    pnpm gonew
  7. 启动开发服务器

    pnpm run dev

🧹 关于 pnpm gonew

  • 执行 pnpm gonew 会自动清理 src 目录下除 assets/App.vuemain.ts 外的所有内容,并重置 App.vue 为最基础模板
  • 适合用来快速获得一个干净的项目骨架,便于自定义开发

💡 推荐用法

  • 建议执行 pnpm gonew,清理模板内容,获得最干净的起步环境
  • 按需添加自己的页面、组件和业务逻辑

📄 许可证

本项目采用 MIT 许可证 - 详情参见 LICENSE 文件

🙏 致谢

以下排名不分先后


⭐️ 如果这个项目对你有帮助,请给它一个 start!

About

基于vue搭建的后台管理界面

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published