diff --git a/README.md b/README.md index eab918f905abd6c6cb5280a60abd03c6d2cdea8c..d476a836b6cf28b215e8966faedd2c90648b04b6 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,23 @@ ### 介绍 `uni-starter`，是一个云端一体的、集成了商用项目开发常见功能的项目模板。 + 如果说uniCloud admin是管理端项目的基础模板，那么uni-starter则是用户端、尤其是移动端的基础模板。 + 在这个模板基础之上快速填充自己的业务，即可很快完成一个应用。 + 地址：[https://codechina.csdn.net/dcloud/uni-starter.git](https://codechina.csdn.net/dcloud/uni-starter.git) #### 项目背景 -我们一直想出一个结合uni-app、uniCloud和openDB以及uni-id和uniCloud admin等，uni全家桶的项目模板； -为了照顾各类应用的开发者，我们取交集最终罗列了如下功能，发现这些就是除业务逻辑外的项目基本功能并把它命名为`uni-starter`。 -uni-starter将节省开发者大量的时间，让开发者集中精力在自己的特色业务上。 +一个应用，其实有很多通用的功能，比如登录注册、头像、设置、拦截器、banner... + +`uni-starter`将这些功能都已经集成好。 + +新建项目选择`uni-starter`模板，即可在此基础上快速开发自己的特色业务。 + 有了uni-starter，再加上schema2code生成前端页面，一个简单应用就可以快速完成。 -uni-starter + uniCloud admin，应用开发从未如此简单快捷！ + +uni-starter + uniCloud admin，提供了用户端和管理端的基础模板，应用开发从未如此简单快捷！ + ### 界面效果 @@ -34,7 +42,7 @@ uni-starter + uniCloud admin，应用开发从未如此简单快捷！ ### 功能模块介绍 #### 1. 拦截器与路由守卫 -第三方路由拦截库，一般带有windows对象等问题并不适合在uni-app中使用；另外传统路由拦截方式都是给原生方法做嵌套，首先这种写法并不优雅，另外不同项目的作者可能会不同的第三方路由库，这非常不利于生态的建设。你可能从插件市场拉下来一个项目有太多的学习成本，与你自有项目结合有大量差异需要去磨平。为此`uni-starter`基于`uni.addInterceptor`拦截器。 +第三方路由拦截库，一般带有window对象等问题并不适合在uni-app中使用；另外传统路由拦截方式都是给原生方法做嵌套，首先这种写法并不优雅，另外不同项目的作者可能会不同的第三方路由库，这非常不利于生态的建设。你可能从插件市场拉下来一个项目有太多的学习成本，与你自有项目结合有大量差异需要去磨平。为此`uni-starter`基于`uni.addInterceptor`拦截器。 拦截器顾名思义，是在框架方法执行的各个环节（包含：拦截前触发、成功回调拦截、失败回调拦截、完成回调拦截）插入逻辑，篡改参数或终止运行。 ``` const {"router": {needLogin,login} } = uniStarterConfig //需要登录的页面 @@ -378,7 +386,7 @@ uni-starter ├─uni_modules 存放[uni_module](/uni_modules)规范的插件。 ├─main.js Vue初始化入口文件 ├─App.vue 应用配置，用来配置App全局样式以及监听 应用生命周期 -├─baseconfig uni-starter的前端的配置文件，项目所有模块的配置在这里填写。详见该文件的代码注释。 +├─uni-starter.config uni-starter的前端的配置文件，项目所有模块的配置在这里填写。详见该文件的代码注释。 ├─manifest.json 配置应用名称、appid、logo、版本等打包信息，详见 └─pages.json 配置页面路由、导航条、选项卡等页面类信息，详见 @@ -400,4 +408,4 @@ uni-starter ### 第三方插件（感谢插件作者，排名不分前后）： 1. 图片裁剪 [limeClipper](https://ext.dcloud.net.cn/plugin?id=3594) @作者： 陌上华年 -2. 二维码生成 [Sansnn-uQRCode](https://ext.dcloud.net.cn/plugin?id=1287) @作者： 3snn \ No newline at end of file +2. 二维码生成 [Sansnn-uQRCode](https://ext.dcloud.net.cn/plugin?id=1287) @作者： 3snn