该项目为前端项目开发模板
,目录和通用工具已经构建好,可以快速启动前端开发。
本项目长期更新,创建项目时记得先拉取最新代码。
创建一个新的项目,假设新项目名为my-project
, 获取到项目的地址为http://my-project.git
。
git clone http://10.10.10.10/front_group/vue-less-quick-start.git # 克隆vue-less-quick-start至本地
git clone http://my-project.git # 克隆新项目至本地
将vue-less-quick-start
中的所有文件(.git 除外),复制到新项目my-project
中,然后将提交代码至远程仓库。
项目创建好后,照下面 👇 步骤进行配置。
- .env 环境变量,配置
VUE_APP_TITLE
。VUE_APP_TITLE
,项目名称,页面 title。用来显示在浏览器的标签页。
- /src/config/index 项目配置文件,配置
baseApiUrl
。baseApiUrl
,后端 api 地址。
- 全局搜索
vue-less-quick-start
,修改为项目名称。 - 👏 此时,项目已经配置完成了,删除你现在正在浏览的
开始创建新项目(构建帮助)
的内容后,就可以自由修改本 readme 了,正式开始新的项目开发 🤨。
本文档包括以下几个部分:
- 安装并运行
- 开发指南
- 上线指南(切记每次更新版本日志)
- 测试指南(测试人员须知)
- 目录规范(前端开发人员须知)
- 项目技术栈
👉 开发前请阅读前端项目规范。
npm install # 安装环境依赖
npm run dev # 或 npm run serve 进入开发模式
npm run lint # 代码格式化
npm run lint-fix # fix代码格式
npm run build-dev # 编译并压缩开发包
npm run build-qa # 编译并压缩测试包
更新版本号:修改/package.json中的version
字段。
更新版本日志:修改/changeLog.md。
npm run build-pro # 编译并压缩生产包
将编译出的
dist-**
压缩后部署到服务端。
- 安装并运行。
- 修改/src/config中的 baseApiUrl,可以切换环境。
- /src/api api 集合,request 封装。
- /src/assets 静态资源目录,包括字体、css、images 等。
- /src/config 项目配置。
- /src/libs 引入的第三方库,不过建议都通过 npm 引入。
- /src/utils 自己封装的工具方法。
- /src/components vue 独立组件,适合抽离具有复用价值的组件。
- /src/router vue-router 路由配置。
- /src/store vuex 全局状态管理。
- /src/views vue 页面。
- vue: 官方文档 vue。
- ant-design-vue: 官方文档 ant-design-vue UI 组件库。
- axios: Github axios 请求库。
- moment: Github 日期格式化库,
ant-design-vue
的日期组件需要。 - nprogress: Github 页面进度条状态库。
- prettier: Github 代码美化工具。
- css 中使用 webpack 别名(alias)
- webpack 中设置了别名,css 中想使用需要在路径前添加
~
。
- webpack 中设置了别名,css 中想使用需要在路径前添加
- Vetur
- Vue 语法高亮、代码提示、Emmet、格式化等功能。
- Prettier
- 可以格式化 JS、JSON、Vue、Less、SCSS 等。
- facebook、react、babel、webpack 推荐。
- Path Autocomplete
- webpack 可以配置
@
别名,但是在代码中使用时没有代码提示,使用这个插件可以实现路径补全。
- webpack 可以配置
- 别名路径跳转
- 虽然使用
Path Autocomplete
可以实现路径补全,但是无法使用ctrl + 点击
或者command + 点击
跳转到该文件,使用这个插件可以实现。
- 虽然使用
- GitLensgit 管理插件
- 每一行代码旁边都会显示代码提交人、提交时间和 message 信息,可以快捷回溯代码。
- 点击侧边栏 GitLens 图标可以查看代码历史。
- 可以操作查看代码 push 记录。
- Better Comments
- 支持注释高亮等。
- Highlight Matching Tag
- 开始闭合标签匹配、开始闭合大括号匹配。