Skip to content
This repository has been archived by the owner on May 30, 2024. It is now read-only.

Latest commit

 

History

History
115 lines (90 loc) · 5.92 KB

README.md

File metadata and controls

115 lines (90 loc) · 5.92 KB

项目快速启动模板

基于 Base 创建的项目模板, 使用 Naive UI 作为组件库


特性


预配置

UI 框架

  • UnoCSS - 高性能且极具灵活性的即时原子化 CSS 引擎
  • Naive UI - 比较完整,主题可调的组件库

Icons

插件

编码风格

开发工具


项目目录结构

  • ***.code-workspace: VsCode 工作区文件, 使用这个打开项目
  • public: 打包后需要放到根目录的文件
  • locales: 国际化文件
  • dist: 打包后的代码
  • src: 源码
    • assets: 存放静态资源
    • styles: 公共样式
    • shared: 公用变量 or 函数
    • lib: 外部依赖库 ( 不满足需求需要重构时或者外部依赖库有 BUG 时, 从 node_modules 移至这里 )
    • utils: 工具函数
    • modules: 项目依赖类库的配置
    • workers: 存放独立的 Web Worker 应用
    • stores: 状态存储
    • composables: 组合式函数
    • components: 公共组件 ( 相对独立的组件, 离开当前项目也能使用的组件 )
    • components-private: 私有组件 ( 只能在当前项目中使用的组件, 比如说包含了业务代码的组件 )
    • layouts: 布局组件
    • pages: 页面

开始

使用项目根目录的 ***.code-workspace 文件进入 VsCode 工作区

安装相应的 VsCode 扩展 ( 首次进入工作区时, 右下角会提示安装 ), 可以在扩展界面, 输入 @recommended 检查安装状态

执行以下命令就可以启动项目

  pnpm dev # 如果你没装过 pnpm, 可以先运行: npm install -g pnpm

项目配置

name ( string ) ( 必填 )

  • 项目名称
  • 默认值: 'Base - Naive UI'