heavyrian2012 vor 3 Jahren
Ursprung
Commit
22c76e9c91
7 geänderte Dateien mit 61 neuen und 187 gelöschten Zeilen
  1. 61 0
      README.md
  2. 0 0
      README_wx_api.md
  3. 0 26
      client/README.md
  4. 0 63
      client/README_wx_client.md
  5. 0 17
      manage/README.md
  6. 0 45
      manage/README_wx_manage.md
  7. 0 36
      server/README.md

+ 61 - 0
README.md

@@ -0,0 +1,61 @@
+# 野火频道服务
+野火频道管理系统,支持多频道接入。提供频道菜单、自动回复、发布文章、CMS等管理功能。使用前需要部署野火IM服务。
+
+## 野火频道系统
+野火频道系统包括3部分。[server](./server)为野火频道服务的后端服务,给管理后台页面和客户端页面提供服务;[manage](./manage)为野火频道管理页面,管理员可以登录并管理频道;[client](./client)为客户端页面,在用户手机展示文章内容。
+
+使用野火频道服务必须部署后端服务、管理后台页面和客户端页面。
+
+## 依赖
+依赖Java1.8/MySQL 5.7+
+
+## 配置
+修改 ```src/main/resources/application-{dev|prod}.yml```文件,配置正确的mysql地址。另外修改```src/main/resources/logback-spring.yml```文件,修改```<fileNamePattern>/usr/local/wx/logs/wx.%d.log</fileNamePattern>``` 行指定存在可读写的路径。
+
+## 编译manage
+进入到[manage](./manage)目录,执行下述命令
+```
+npm install
+npm run build
+```
+
+## 编译client
+进入到[client](./client)目录,执行下述命令
+```
+npm install
+npm run build
+```
+
+*** 注意,要先编译```manage```再编译```client```,因为前端页面编译后会拷贝到后端的static目录,后编译```manage```会覆盖所有的资源。 ***
+
+## 编译后端
+进入到[server](./server)目录,执行下述命令
+```shell
+mvn clean package
+```
+生产软件包```channel-api.jar```在```target```目录下。
+
+## 配置
+修改 ```server/config/application-{dev|prod}.yml```文件,配置正确的mysql地址。另外修改```server/config/logback-spring.yml```文件,修改```<fileNamePattern>/usr/local/wx/logs/wx.%d.log</fileNamePattern>``` 行指定存在可读写的路径。
+
+## 运行
+把```server/config```目录拷贝到```channel-api.jar```同目录,然后执行下面语句:
+```shell
+java -jar channel-api.jar
+```
+
+## 登录
+需要部署后端管理页面,具体方法参考管理页面项目。使用用户名密码 ```admin/123456``` 来进行登录,登录后可以修改管理员密码和添加更多管理员。
+
+## 对接野火IM服务
+1. 在野火IM服务创建频道,频道```auto```参数为1,```callback```为 ```http://{频道后端IP}:8890/{频道ID}```。
+2. 在管理页面添加频道,填入IM服务地址(端口是80),频道ID和频道密钥。
+
+## 测试
+测试菜单,自动回复,文章等功能。
+
+## 前后端分离
+默认编译```client```和```manage```会把前端页面放到```server```的```static```目录。也可以前后端分离部署,把前端页面单独部署。
+
+## 项目来源
+项目Base于[wx-api](https://github.com/niefy/wx-api)。

+ 0 - 0
server/README_wx_api.md → README_wx_api.md


+ 0 - 26
client/README.md

@@ -1,26 +0,0 @@
-# 野火频道客户端页面
-当客户端阅读文章时,需要使用到此页面。
-
-## 开发环境
-- node.js
-
-## 启动步骤
-1. 启动后端服务
-2. 安装依赖
-
-``` bash
-npm install
-```
-3. 编译构建
-``` bash
-# 开发环境
-npm run serve
-
-# 生产环境
-npm run build
-```
-4. 浏览器打开如下地址:
-    - 首页:http://localhost:8080
-
-## 感谢
-项目基于[wx-client](https://github.com/niefy/wx-client)。

+ 0 - 63
client/README_wx_client.md

@@ -1,63 +0,0 @@
-# wx-client
-微信公众号接口[wx-api](https://github.com/niefy/wx-api)前端项目,包含微信登录、微信分享、CMS文章示例功能
-
-## 开发环境
-- node.js
-
-## 启动步骤
-1. 启动[wx-api](https://github.com/niefy/wx-api)项目,具体流程参考对应项目介绍
-2. 安装依赖
-
-``` bash
-npm install
-```
-3. 修改.env.development开发环境配置文件
-4. 编译构建
-``` bash
-# 开发环境
-npm run serve
-
-# 生产环境
-npm run build
-```
-5. 浏览器打开如下地址:
-    - 首页:http://localhost:8080
-
-## 体验微信分享、微信授权登录等功能
-由于微信分享和微信登录功能需在正式域名下使用,有如下两种方式体验
-### 方式一:部署到生产环境再看
-生产环境建议打包后将文件部署到nginx,后端请求使用nginx转发功能
-nginx.conf配置
-```
-location /wx/ { #转发后端接口
-    proxy_pass   http://127.0.0.1:8088/wx/;
-}
-```
-### 方式二:使用ngrok穿透到内网
-然后配置ngrok映射到nginx端口:http://xxx.ngrok.io -> http://localhost:8080
-```
-ngrok http  8080
-```
-
-### 不管哪种方式都需要检查如下配置:
- - 公众号/测试号后台:接口配置是否成功
- - 公众号/测试号后台:JS接口安全域名,只填域名,不要带协议及URL,如:xxx.ngrok.io
- - 公众号/测试号后台:网页授权回调域名,只填域名,不要带协议及URL,如:xxx.ngrok.io
-
-然后可以微信访问开发环境页面或者使用微信开发者工具打开
-    - 文章(微信分享)示例:http://xxx.ngrok.io/client/article/1
-    - 微信登录示例:http://xxx.ngrok.io/client/wxLogin
-
-
-## 截图
-![首页](https://s1.ax1x.com/2020/06/04/tBI5dA.jpg)
-![订阅](https://s1.ax1x.com/2020/06/04/tBIfqH.jpg)
-![关注](https://s1.ax1x.com/2020/06/04/tBIWse.jpg)
-![文章](https://s1.ax1x.com/2020/06/04/tBI4Zd.jpg)
-
-## 生产环境如何部署(需先部署wx-api)
-1. 配置wx-client目录下.env.production文件
-2. 编译打包:npm run build
-3. 将打包后的dist目录内文件上传到服务器nginx的资源目录(默认目录名是html)
-4. 修改nginx.conf配置,将/wx/ 请求转发到wx-api生产环境接口地址
-5. 域名映射到nginx所在服务器,前往微信公众号后台配置做开发配置

+ 0 - 17
manage/README.md

@@ -1,17 +0,0 @@
-# 野火频道管理端
-野火频道的管理前端页面,需要配置后端服务使用。
-
-## 开发
-```
-npm install
-npm run serve
-```
-
-## 编译
-```
-npm install
-npm run build
-```
-
-## 项目Base
-项目基于[wx-manage](https://github.com/niefy/wx-manage)二次开发。

+ 0 - 45
manage/README_wx_manage.md

@@ -1,45 +0,0 @@
-# wx-manage
-wx-manage是一个支持公众号管理系统,支持多公众号接入。
-wx-manage提供公众号菜单、自动回复、公众号素材、简易CMS、等管理功能,请注意本项目仅为管理后台界面,需配合后端程序[wx-api](https://github.com/niefy/wx-api)一起使用
-
-### [📖项目文档](https://www.yuque.com/nifury/wx) | [Github仓库](https://github.com/niefy/wx-manage) | [码云仓库](https://gitee.com/niefy/wx-manage)
-
-## 项目说明
-- wx-api是一个轻量级的公众号开发种子项目,可快速接入频道公众号管理功能
-- 管理后台前端项目wx-manage:https://github.com/niefy/wx-manage
-- 移动端示例wx-client: https://github.com/niefy/wx-client
-
-## [docker方式启动文档](https://www.yuque.com/nifury/wx/nf1rvm)
-## [开发环境启动文档](https://www.yuque.com/nifury/wx/guobb7)
-## [生产环境部署步骤](https://www.yuque.com/nifury/wx/ofehhv)
-
-## 技术选型:
-- 核心框架:Spring Boot
-- 安全框架:Apache Shiro
-- 持久层框架:MyBatis-Plus
-- 公众号开发框架:[WxJava](https://github.com/Wechat-Group/WxJava)
-- 后端脚手架:[renren-fast](https://gitee.com/renrenio/renren-fast)
-- 页面交互:[Vue2.x](https://cn.vuejs.org/v2/guide/)
-- UI框架:[ElementUI](https://element.eleme.cn/#/zh-CN/component/quickstart)
-- 管理后台界面模板:[renren-fast-vue](https://gitee.com/renrenio/renren-fast-vue)
-- 富文本编辑器:[tinymce5](https://www.tiny.cloud/docs/quick-start/)
-
-## 截图
-![公众号账号](https://s1.ax1x.com/2020/06/23/NUTQAg.png)
-![公众号菜单](https://s1.ax1x.com/2020/06/23/NUTlNQ.png)
-![自动回复](https://s1.ax1x.com/2020/04/10/GTqyQA.png)
-![模板消息配置](https://s1.ax1x.com/2020/04/18/JnKZhF.jpg)
-![模板消息发送](https://s1.ax1x.com/2020/04/18/JnKEkT.jpg)
-![粉丝管理](https://s1.ax1x.com/2020/04/18/JnKVtU.jpg)
-![带参二维码](https://s1.ax1x.com/2020/04/18/JnKF00.jpg)
-![素材管理](https://s1.ax1x.com/2020/05/20/Y7djHI.jpg)
-![公众号消息](https://s1.ax1x.com/2020/05/20/Y7dXDA.jpg)
-![文章编辑](https://s1.ax1x.com/2020/04/10/GTqrzd.png)
-![系统菜单管理](https://s1.ax1x.com/2020/04/18/JnKk7V.jpg)
-![管理员列表](https://s1.ax1x.com/2020/04/18/JnKimq.jpg)
-
-
-## [项目开发进度](https://www.yuque.com/nifury/wx/kens6d)
-## [代码贡献指南](https://www.yuque.com/nifury/wx/ykqswi)
-## 开发交流
-QQ群:1023785886(已满)、993128490 技术交流群严禁广告,发广告立即踢出+拉黑+举报,加群密码:wx

+ 0 - 36
server/README.md

@@ -1,36 +0,0 @@
-# 野火频道服务
-野火频道管理系统,支持多频道接入。提供频道菜单、自动回复、发布文章、CMS等管理功能。使用前需要部署野火IM服务。
-
-## 野火频道系统
-野火频道系统包括3部分。第一部分是此项目,为野火频道服务的后端服务,给管理后台页面和客户端页面提供服务;第二部分为野火频道管理页面,管理员可以登录并管理频道;第三部分为客户端页面,在用户手机展示文章内容。
-
-使用野火频道服务必须部署后端服务、管理后台页面和客户端页面。
-
-## 依赖
-依赖Java1.8/MySQL 5.7+
-
-## 配置
-修改 ```src/main/resources/application-{dev|prod}.yml```文件,配置正确的mysql地址。另外修改```src/main/resources/logback-spring.yml```文件,修改```<fileNamePattern>/usr/local/wx/logs/wx.%d.log</fileNamePattern>``` 行指定存在可读写的路径。
-
-## 编译
-```shell
-mvn clean package
-```
-
-## 运行
-```shell
-java -jar channel-api.jar
-```
-
-## 登录
-需要部署后端管理页面,具体方法参考管理页面项目。使用用户名密码 ```admin/admin123``` 来进行登录,登录后可以修改管理员密码和添加更多管理员。
-
-## 对接野火IM服务
-1. 在野火IM服务创建频道,频道```auto```参数为1,```callback```为 ```http://{频道后端IP}:8890/wx/{频道ID}```。
-2. 在管理页面添加频道,填入IM服务地址(端口是80),频道ID和频道密钥。
-
-## 测试
-测试菜单,自动回复,文章等功能。
-
-## 项目来源
-项目Base于[wx-api](https://github.com/niefy/wx-api)。