109 lines
5.0 KiB
Markdown
109 lines
5.0 KiB
Markdown
# project
|
||
|
||
#### 介绍
|
||
{**以下是 Gitee 平台说明，您可以替换此简介**
|
||
Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台
|
||
无论是个人1、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)}
|
||
|
||
## 目录说明
|
||
```
|
||
站点根目录
|
||
├─common //公共文件
|
||
├─api //api接口定义
|
||
├─css //公共css定义
|
||
└─js //公共js定义
|
||
├─components //uniapp组件目录
|
||
├─framework //自定义js框架
|
||
├─0-conf.js //项目请求地址配置
|
||
├─1-utils.js //工具js
|
||
├─2-url.js //获取当前页面路由地址
|
||
├─3-pro.js //uni系统相关api
|
||
├─4-queue.js //队列
|
||
├─5-pro-ext.js //页面跳转相关方法
|
||
├─6-event.js //事件监听
|
||
├─7-qiniu.js //七牛云js
|
||
├─8-cache.js //缓存方法
|
||
├─9-modal.js //AB页面传参
|
||
├─11-api.js //uni.request()方法封装
|
||
├─13-mixin //页面混入方法
|
||
├─14-device.js //调用uni系统震动
|
||
├─bootstrap.js //js入口文件
|
||
├─bridge.js //与原生交互
|
||
├─md5.js //md5加密
|
||
├─sign.js //签名
|
||
├─vConsole.js //控制台
|
||
├─pages //应用页面
|
||
├─home //个人中心
|
||
├─index //首页
|
||
├─news //新闻
|
||
├─public //公共页面(登录注册)
|
||
├─shop //商城页面
|
||
├─type //分类页面
|
||
├─web //项目外链
|
||
├─static //图片资源
|
||
├─store //vuex状态管理
|
||
├─unpackage //编译后目录
|
||
├─uview-ui //uview-ui插件依赖
|
||
├─app.vue //uni-app配置文件
|
||
├─main.js //vue入口js
|
||
├─manifest.json //uniapp项目配置文件
|
||
├─pages.json //页面路由配置页
|
||
├─uni.scss //uniapp内置的常用样式变量
|
||
```
|
||
#### 项目说明
|
||
1. 项目基于Vue-uniApp，使用uview框架。
|
||
|
||
#### 安装教程
|
||
|
||
1. 下载安装：「HBuildX」
|
||
2. 将项目拖进【HBuildX】- 运行 - 运行到浏览器 - 完成
|
||
|
||
|
||
#### 使用说明
|
||
1. ui框架使用uviewui https://www.uviewui.com/js/intro.html
|
||
2. 请求接口统一定义在common/index.js (使用方式uni.ajax(option)
|
||
3. 状态管理 使用vuex模块(module)
|
||
4. css布局采用flex布局(详见common/css/flex.css)
|
||
5. 接口域名配置(framework/0-conf.js)
|
||
const debug = true//true是本地代理配置false服务器环境
|
||
const proxyApi = "/api/"
|
||
let baseUrl="";
|
||
uni.is_online = false; //false 为测试服 true正式服
|
||
if (uni.is_online) {
|
||
//正式
|
||
baseUrl = debug ? proxyApi : 'http://mc.test.hmsc000111.com/'
|
||
} else {
|
||
// 测试
|
||
baseUrl = debug ? proxyApi : 'http://mc.test.hmsc000111.com/'
|
||
}
|
||
#### 开发规范
|
||
0. 写注释要注意：写明代码的作用，重要的地方写注释
|
||
1. js使用ES6语法
|
||
2. 页面布局flex布局
|
||
3. 减少页面代码体积，复杂，重复性代码应提取封装成组件引入
|
||
4. 公共js函数统一封装在common/js目录下
|
||
5. css统一使用scss
|
||
6. 加载外链使用 page/web/index.vue
|
||
7. 公共组件封装在根目录下 components 命名方式(ixxxxxx)
|
||
8. 某个页面独享组件(封装在当前页面所在目录下components)
|
||
9. 图片:除非特别要求图片必须高质量的显示，否则都应该进行对应的压缩处理
|
||
10. 避免过多的if else判断
|
||
|
||
|
||
|
||
#### 参与贡献
|
||
|
||
1. Fork 本仓库
|
||
2. 新建 Feat_xxx 分支
|
||
3. 提交代码
|
||
4. 新建 Pull Request
|
||
|
||
|
||
#### 特技
|
||
|
||
1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
|
||
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
|
||
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
|
||
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
|
||
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
|
||
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) |