doc: 增加轻商城文档

2019-04-19 18:29:46 +08:00
parent 1b1a894573
commit 4ee32ff648
6 changed files with 115 additions and 82 deletions
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@

 又一个小商场系统。

-litemall = Spring Boot后端 + Vue管理员前端 + 微信小程序用户前端
+litemall = Spring Boot后端 + Vue管理员前端 + 微信小程序用户前端 + Vue用户移动端

 * [文档](https://linlinjava.gitbook.io/litemall)
 * [贡献](https://linlinjava.gitbook.io/litemall/contribute)
@@ -20,6 +20,12 @@ litemall = Spring Boot后端 + Vue管理员前端 + 微信小程序用户前端
 ![](./doc/pic/litemall_wx_demo.png)    
 > 注意：此实例是测试小商场，开发者请不要尝试购买商品、付款、退款操作。

+### 轻商场实例
+
+目前未部署
+
+![](./doc/pic/5.gif)    
+
 ### 管理后台实例

 ![](./doc/pic/4.png)    
@@ -122,6 +128,20 @@ litemall = Spring Boot后端 + Vue管理员前端 + 微信小程序用户前端
   > 这里只是最简启动方式，而小商场的微信登录、微信支付等功能需开发者设置才能运行，
   > 更详细方案请参考[文档](https://linlinjava.gitbook.io/litemall/project)。

+6. 启动轻商城前端
+
+    打开命令行，输入以下命令
+    ```bash
+    npm install -g cnpm --registry=https://registry.npm.taobao.org
+    cd litemall/litemall-vue
+    cnpm install
+    cnpm run dev
+    ```
+    此时，浏览器（建议采用chrome 手机模式）打开，输入网址`http://localhost:6255`, 此时进入轻商场。
+
+    注意：
+    > 现在功能很不稳定，处在开发阶段。
+        
 ## 开发计划

 当前版本[v1.3.0](https://linlinjava.gitbook.io/litemall/changelog)
@@ -139,6 +159,7 @@ V 2.0.0 完成以下目标：
 1. 小商城和管理后台完成所有基本业务；
 2. 管理后台实现统计功能、日志功能、权限功能；
 3. 业务代码和细节代码进行调整优化；
+4. 轻商城的开发；

 V 3.0.0 完成以下目标：

@@ -169,20 +190,26 @@ V 3.0.0 完成以下目标：
  
   项目介绍： 一个基于Vue和Element的后台集成方案
  
-   项目参考：litemall项目的litemall-admin模块的前端框架基于该项目修改扩展。
+   项目参考：litemall项目的litemall-admin模块的前端框架基于vue-element-admin项目修改扩展。

 3. [mall-admin-web](https://github.com/macrozheng/mall-admin-web)

   项目介绍：mall-admin-web是一个电商后台管理系统的前端项目，基于Vue+Element实现。

-   项目参考：litemall项目的litemall-admin模块的一些页面布局样式参考了该项目。
+   项目参考：litemall项目的litemall-admin模块的一些页面布局样式参考了mall-admin-web项目。

 4. [biu](https://github.com/CaiBaoHong/biu)

   项目介绍：管理后台项目开发脚手架，基于vue-element-admin和springboot搭建，前后端分离方式开发和部署。

-   项目参考：litemall项目的权限管理功能参考了该项目。
+   项目参考：litemall项目的权限管理功能参考了biu项目。

+5. [vant--mobile-mall](https://github.com/qianzhaoy/vant--mobile-mall)
+
+   项目介绍：基于有赞 vant 组件库的移动商城。
+
+   项目参考：litemall项目的litemall-vue模块基于vant--mobile-mall项目开发。
+   
 ## 问题

 ![](doc/pic/qq.png)
--- a/doc/README.md
+++ b/doc/README.md
@@ -7,4 +7,5 @@
 * [1. 系统架构](./project.md)
 * [2. 基础系统](./platform.md)
 * [3. 小商场](./wxmall.md)
-* [4. 管理后台](./admin.md)
+* [4. 管理后台](./admin.md)
+* [5. 轻商城](./mobmall.md)
--- a/doc/mobmall.md
+++ b/doc/mobmall.md
@@ -0,0 +1,30 @@
+# 5 litemall轻商城
+
+litemall轻商城，是商城移动版本。
+
+技术：
+
+* 轻商城前端，即litemall-vue模块
+  * power by vue-cli3 
+  * Vue + Vue-router + Vant + Sass
+  * axios
+  * vee-validate
+  * fastclick
+  * babel-polyfill
+  * @xkeshi/vue-countdown
+  * Vant
+* 轻商城前端，即litemall-wx-api模块，也就是和小商城后端是一样的。
+  * Spring Boot 2.x
+  * Spring MVC
+  * [weixin-java-tools](https://gitee.com/binary/weixin-java-tools)
+
+
+## 5.1 litemall-wx-api
+
+可以阅读3.1
+
+## 3.2 litemall-vue
+
+这里的代码基于[vant--mobile-mall](https://github.com/qianzhaoy/vant--mobile-mall)
+
+文档未完成。
--- a/doc/pic/5.gif
+++ b/doc/pic/5.gif
--- a/doc/project.md
+++ b/doc/project.md
@@ -2,30 +2,35 @@

 ## 1.1 简介

-litemall是一个简单的商场系统，基于现有的开源项目，重新实现一个完整的前后端项目，包含小程序客户端和网页管理端。
+litemall是一个简单的商场系统，基于现有的开源项目，重新实现一个完整的前后端项目，包含小程序客户端、移动客户端和网页管理端。

 ![](./pic1/1-1.png)    


-项目的架构是三个系统和六个模块：
+项目的架构是四个系统和九个模块：

 * 基础系统子系统(platform)

  由数据库、litemall-core模块、litemall-db模块和litemall-all模块组成;

-* 小商场子系统(wxmall)
+* 小商场子系统(wxmall，即weixin mall)

  由litemall-wx-api模块、litemall-wx模块和renard-wx模块组成；

+* 轻商城子系统(mobmall，即mobile mall)
+
+  由litemall-wx-api模块和litemall-vue模块组成。
+  注意，目前这里移动商城子系统的后端和小商场子系统是一样的。
+
+* 简商城子系统(webmall)
+
+  这里仅列出，目前没有开发计划。
+    
 * 管理后台子系统(admin)

  由litemall-admin-api模块和litemall-admin模块组成。

-* 简单商城系统(mall)
-
-  这里仅列出，目前没有开发计划。
-
-而六个模块的开发设计到三种技术栈：
+而九个模块的开发设计到三种技术栈：

 * Spring Boot技术栈

@@ -38,19 +43,20 @@ litemall是一个简单的商场系统，基于现有的开源项目，重新实
  
 * Vue技术栈

-  采用VSC开发工具，开发litemall-admin模块。
+  采用VSC开发工具，开发litemall-admin模块和litemall-vue模块。

 ## 1.2 系统功能

-从业务功能上，目前由五个业务模块组成：
+从业务功能上，目前由六个业务模块组成：

 * 会员业务模块
 * 商场业务模块
 * 商品业务模块
 * 推广业务模块
 * 系统业务模块
+* 配置业务模块

-### 1.2.1 小程序端功能
+### 1.2.1 小商城功能

 * 首页
 * 专题列表、专题详情
@@ -68,7 +74,29 @@ litemall是一个简单的商场系统，基于现有的开源项目，重新实
 * 地址列表、地址添加、地址删除
 * 收藏、足迹、关于

-### 1.2.2 管理平台功能
+### 1.2.1 轻商城功能
+
+**目前还在开发中，不稳定**
+
+以下是准备完成的功能：
+
+* 首页
+* 专题列表、专题详情
+* 分类列表、分类详情
+* 品牌列表、品牌详情
+* 新品首发、人气推荐
+* 团购
+* 搜索
+* 商品详情
+* 商品评价列表、商品评价
+* 购物车
+* 下单
+* 个人
+* 订单列表、订单详情
+* 地址列表、地址添加、地址删除
+* 收藏、足迹、关于
+
+### 1.2.3 管理平台功能

 * 会员管理
  * 会员管理
@@ -98,11 +126,15 @@ litemall是一个简单的商场系统，基于现有的开源项目，重新实
 * 系统管理
  * 管理员
  * 对象存储
-  * 权限管理（待定）
+  * 权限管理
  * 定时任务（待定）
-  * 参数管理（待定）
-  * 系统日志（待定）
-* 统计管理
+  * 操作日志
+* 配置管理
+  * 商场配置
+  * 小程序配置
+  * 运费配置
+  * 订单配置
+* 统计报表
  * 用户统计
  * 订单统计
  * 商品统计
@@ -607,6 +639,10 @@ litemall:
 当配置好信息以后，开发者可以litemall-core模块的`ExpressTest`测试类中设置快递公司编码和
 真实测试快递单号，独立启动`ExpressTest`测试类查询物流信息。

+注意：
+> 一部分快递公司（例如顺丰速运、申通快递等）的轨迹查询在开发环境下不支持，
+> 具体支持情况或者使用限制请阅读[官方资料](http://www.kdniao.com/UserCenter/v2/UserHome.aspx)
+
 #### 1.4.5.9 对象存储配置

 对象存储，即存储和下载文件。
--- a/litemall-vue/README.md
+++ b/litemall-vue/README.md
@@ -1,61 +0,0 @@
-# liteMall 移动商城
-
- 本项目是小程序的 vue 版本，样式大体相同，欢迎有能力的人贡献更优秀的代码
-
-> 使用有赞移动端 Vue 组件库 — [Vant](https://www.youzanyun.com/zanui/vant#/zh-CN/component/intro)
-
- 
-## Vue相关库与插件
-
- power by vue-cli3 
- Vue + Vue-router + Vant + Sass
- axios
- vee-validate
- fastclick
- babel-polyfill
- @xkeshi/vue-countdown
-
- 
-## Build Script
-
-``` bash
-# install dependencies
-npm install
-
-# serve with hot reload at localhost:6255  九键输入法的 「mall」= 「6255」
-npm run serve
-
-# build for production with minification : build result at /dist
-npm run build 
-
-# build for production and view the bundle analyzer report
-npm run build -- --report
-```
-
- 简单预览：
-
-[![AqVx1g.md.png](https://s2.ax1x.com/2019/04/12/AqVx1g.md.png)](https://imgchr.com/i/AqVx1g)
-
-[![AqZZ3F.md.gif](https://s2.ax1x.com/2019/04/12/AqZZ3F.md.gif)](https://imgchr.com/i/AqZZ3F)
-
-
-### 一些 Tips
-
- 手机浏览或 chrome 手机模式：开发/浏览 体验更佳
-
- 运行项目
-
-```bash
-npm i && npm run serve
-```
-
- 打包项目
-
-```bash
-# /dist copy to you http server 
-npm run build 
-```
-
-
-
-