majorel-saas-crm

Majorel SaaS CRM

---

开发前置

1. 需要 Node.js 版本 >= 12.0.0
2. 本项目要求使用 pnpm, 安装pnpm => npm install -g pnpm
3. 复制一份local-config-template.ts文件并名命为 local-config.ts(本地个性化配置文件)
4. vscode 安装插件 Eslint、Prettier、Vetur
5. 命令行执行pnpm先安装 npm 包,然后执行 pnpm docs:dev 访问在线文档学习相关技术栈
6. pnpm 与 yarn、npm 使用对比

npm	yarn	pnpm
npm install	yarn	pnpm install
npm install vue --save	yarn add vue	pnpm add vue
npm uninstall vue --save	yarn remove vue	pnpm remove vue
npm install vue --save-dev	yarn add vue --dev	pnpm add vue -D
npm update --save	yarn upgrade	pnpm update

开发

// 安装依赖包
pnpm i

// 启动b系统开发环境
pnpm dev:b

// 启动o系统开发环境
pnpm dev:o

// 构建b系统sit环境
pnpm build:sit_b

// 构建o系统sit环境
pnpm build:sit_o

// 启动标签b系统开发环境
pnpm dev:tag_b

// 启动标签o系统开发环境
pnpm dev:tag_o

// 构建标签b系统sit环境
pnpm build:tag_sit_b

// 构建标签o系统sit环境
pnpm build:tag_sit_o

// eslint语法检查
pnpm lint

// prettier格式化代码
pnpm format

// 启动文档开发环境
pnpm docs:dev

// 构建文档
pnpm docs:build

// 预览构建文档
pnpm docs:serve

项目目录结构

web
|—— .vscode -- vscode编辑器设置
|── docs -- 项目文档 pnpm docs:dev 可以开启本地编辑模式
|—— packages -- 包文件夹
| |—— common -- 跨项目公共包文件
| |—— projects -- 项目文件夹
| | |—— saas-b -- b业务系统
| | | |── env -- 环境变量文件
| | | |—— mock -- 数据模拟用于无后端服务模式下的本地调试
| | | |—— public -- 网站公共资源
| | | | |—— favicon.ico -- 浏览器标签快捷图标
| | | |—— scripts -- 网站工具脚本
| | | |—— src -- 网站源码
| | | | |—— api -- 所有请求
| | | | |—— assets -- 放置字体图片等静态资源
| | | | |—— components -- 通用组件目录
| | | | | |—— Base -- 基础组件
| | | | |—— hooks -- 可复用的 js 业务逻辑
| | | | |—— lang -- 多语言配置
| | | | |—— layout -- 网站布局组件
| | | | |—— router -- 路由配置
| | | | |—— store -- vuex 状态管理
| | | | | |-- modules 状态模块
| | | | | |-- index.ts 状态管理入口文件
| | | | |—— styles -- 网站样式文件目录
| | | | |—— utils -- 网站工具方法目录
| | | | |—— views -- 页面视图
| | | | |—— App.vue -- vue 入口组件
| | | | |—— env.d.ts -- ts 类型定义文件
| | | | |—— main.ts -- 系统入口文件
| | | |—— index.html -- html
| | | |—— local-config-template.ts -- 本地开发环境变量配置模板（作用 eg: 控制 mock 数据开关）
| | | |—— local-config.ts -- 不作为 git 提交项 防止冲突(代码拉下来之后各自按照 local-config-template.ts 新建)
| | | |—— vite.config.ts -- vite 配置文件
|—— scripts --全局构建脚本
|—— .eslintignore -- eslint忽略文件配置
|—— .eslintrc.js -- eslint 规则配置文件
|—— .gitignore -- 设置不需要提交 git 的文件
|—— .prettierrc -- prettier 代码格式化规则配置
|—— CHANGELOG.md -- 版本发布日志
|—— nginx.conf -- 部署生产nginx配置参考
|—— package.json -- 包管理文件
|—— pnpm-lock.yaml -- pnpm锁版本文件
|—— pnpm-workspace.yaml -- pnpm声明workspace
|—— README.md -- 网站描述文件
|—— tsconfig.json -- ts 配置文件

相关文档

• mock
• vue3 官方文档
• vue-router4.0 官方文档
• vuex4.0 官方文档
• vite 官方文档
• ts 官方文档
• element-plus
• vue-i18n
• pnpm
• draggable
• wangeditor
• echarts
• butterfly
• antv/x6