Browse Source

add readme.md

heavyrian2012 3 years ago
parent
commit
bf730877d4
4 changed files with 63 additions and 29 deletions
  1. 1 0
      .gitignore
  2. 40 0
      README.md
  3. 0 10
      server/README.md
  4. 22 19
      server/config/application.properties

+ 1 - 0
.gitignore

@@ -1 +1,2 @@
 server/src/main/resources/static
+daily_report.mv.db

+ 40 - 0
README.md

@@ -0,0 +1,40 @@
+# 野火日报服务
+野火日报服务是[野火开放平台](https://github.com/wildfirechat/open-platform)中的一个demo应用,用来演示如何开发或则对接第三方应用系统。
+
+## 创建应用
+在野火开放平台创建应用,填写预先分配给应用的地址,创建完成后得到appid和appsecret。
+
+## Demo前端的编译
+进入到web目录,执行如下命令:
+```
+npm install
+npm run build
+```
+编译成功后会自动放入到后端的static目录,不用手动拷贝。
+
+## Demo后端的编译
+进入到server目录,执行如下命令:
+```
+mvn clean package
+```
+
+## 配置
+编译后的软件包在target目录下的```daily-report-0.1.jar```,包中已经包含了前后端的代码。运行时需要把server目录中的config目录拷贝到此jar的同级目录。
+```
+# IM服务地址,注意端口是80,不是管理API的18080.
+im.url=http://wildfirechat.net
+# 应用ID
+application.id=xxxxxxxx
+# 应用密钥
+application.secret=123456
+```
+此外还有其它配置,比如端口和数据库可以配置。默认使用的是h2数据库,上线前请切换到MySQL或则其它关系型数据库。
+
+## 运行
+执行命令
+```
+nohup java -jar daily-report-0.1.jar 2>&1 &
+```
+
+## 验证
+手机打开工作页面,点击创建的应用,进入应用测试。

+ 0 - 10
server/README.md

@@ -1,10 +0,0 @@
-# 服务模版
-## 登陆
-curl -H "Content-Type: application/json" -X POST  --data '{"account":"admin","password":"admin123"}' -v  http://127.0.0.1:8880/api/login
-
-## 获取账号
-curl -X POST -H "authToken:6d4be0cab0644bd39d68d98f34ce7fa0" -v http://127.0.0.1:8880/api/account
-> authToken为第一步登陆成功返回的header中的authToken,如果用cookies也是可以的。
-
-## 打开首页
-浏览器打开 http://127.0.0.1:8880/

+ 22 - 19
server/config/application.properties

@@ -3,33 +3,33 @@ server.port=8881
 
 # h2适合开发使用,上线时请切换到mysql。切换时把下面h2部分配置注释掉,打开mysql部署配置。
 ##*********************** h2 DB begin ***************************
-#spring.datasource.url=jdbc:h2:file:./daily_report;AUTO_SERVER=TRUE;MODE=MySQL
-#spring.datasource.username=sa
-#spring.datasource.password=
-#spring.datasource.driver-class-name=org.h2.Driver
-#spring.jpa.database=h2
-#spring.jpa.defer-datasource-initialization=true
-#spring.sql.init.mode=always
+spring.datasource.url=jdbc:h2:file:./daily_report;AUTO_SERVER=TRUE;MODE=MySQL
+spring.datasource.username=sa
+spring.datasource.password=
+spring.datasource.driver-class-name=org.h2.Driver
+spring.jpa.database=h2
+spring.jpa.defer-datasource-initialization=true
+spring.sql.init.mode=always
 ##spring.sql.init.mode为always时,每次启动都会初始化resource目录下的data.sql日志,所以需要spring.sql.init.continue-on-error继续执行。
 ##如果上线,需要spring.sql.init.mode为false,然后手动初始化数据。
-#spring.sql.init.continue-on-error=true
-#spring.jpa.hibernate.ddl-auto=update
+spring.sql.init.continue-on-error=true
+spring.jpa.hibernate.ddl-auto=update
 ##*********************** h2 DB end ******************************
 
 # mysql默认配置
 # mysql需要手动创建数据库,mysql命令行下执行 create database application_server;
 ##*********************** mysql DB begin *************************
-spring.datasource.url=jdbc:mysql://localhost:3306/daily_report?serverTimezone=UTC&useSSL=false&allowPublicKeyRetrieval=true&createDatabaseIfNotExist=true
-spring.datasource.username=root
-spring.datasource.password=123456
-spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
-spring.jpa.database=mysql
-spring.jpa.defer-datasource-initialization=true
-spring.sql.init.mode=always
+#spring.datasource.url=jdbc:mysql://localhost:3306/daily_report?serverTimezone=UTC&useSSL=false&allowPublicKeyRetrieval=true&createDatabaseIfNotExist=true
+#spring.datasource.username=root
+#spring.datasource.password=123456
+#spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
+#spring.jpa.database=mysql
+#spring.jpa.defer-datasource-initialization=true
+#spring.sql.init.mode=always
 ##spring.sql.init.mode为always时,每次启动都会初始化resource目录下的data.sql日志,所以需要spring.sql.init.continue-on-error继续执行。
 ##如果上线,需要spring.sql.init.mode为false,然后手动初始化数据。
-spring.sql.init.continue-on-error=true
-spring.jpa.hibernate.ddl-auto=update
+#spring.sql.init.continue-on-error=true
+#spring.jpa.hibernate.ddl-auto=update
 ##*********************** mysql DB end ***************************
 
 # 是否支持SSL,如果所有客户端调用appserver都支持https,请把下面开关设置为true,否则为false。
@@ -37,6 +37,9 @@ spring.jpa.hibernate.ddl-auto=update
 # 详情请参考 https://www.baidu.com/s?wd=cookie+SameSite&ie=utf-8
 wfc.all_client_support_ssl=false
 
-im.url=http://localhost
+# IM服务地址,注意端口是80,不是管理API的18080.
+im.url=http://wildfirechat.net
+# 应用ID
 application.id=xxxxxxxx
+# 应用密钥
 application.secret=123456