diff --git a/client/mobile/package.json b/client/mobile/package.json index 996ea379..9d35addf 100644 --- a/client/mobile/package.json +++ b/client/mobile/package.json @@ -8,6 +8,7 @@ "ios": "react-native run-ios", "lint": "eslint .", "start": "react-native start", + "doctor": "react-native doctor", "patch-package": "patch-package", "postinstall": "patch-package", "plugins:all": "ministar buildPlugin all", diff --git a/website/docs/deployment/mobile.md b/website/docs/deployment/mobile.md new file mode 100644 index 00000000..673a872c --- /dev/null +++ b/website/docs/deployment/mobile.md @@ -0,0 +1,155 @@ +--- +sidebar_position: 12 +title: Mobile Self Compile (optional) +--- + +The source code of `Tailchat` mobile terminal is located in `client/mobile`. The technology stack is `react-native` + +You can download the compiled general version directly from the official website: [https://tailchat.msgbyte.com/downloads](https://tailchat.msgbyte.com/downloads), or compile it yourself from the source code + +This section mainly explains how to compile the mobile version of `Tailchat`. + +## Prepare the development environment + +You can see the complete development environment preparation operation at [https://reactnative.dev/docs/environment-setup](https://reactnative.dev/docs/environment-setup), so I won’t go into details here. + +### Install dependencies + +```bash +cd client/mobile +yarn +``` + +### Environment check + +```bash +yarn doctor +``` + +## Prepare environment variables + +```bash +cp.env.example.env +``` + +In the `.env` file we configure the required environment variables for compilation + +```ini +TAILCHAT_UPLOAD_STORE_FILE= +TAILCHAT_UPLOAD_STORE_PASSWORD= +TAILCHAT_UPLOAD_KEY_ALIAS= +TAILCHAT_UPLOAD_KEY_PASSWORD= + +GETUI_APPID= +GETUI_APPKEY= +GETUI_APPSECRET= +GETUI_HUAWEI_APP_ID= +``` + +## Certificate signing + +If you are only using it for testing, you can skip this section and Tailchat will sign it for you using a public test certificate. + +### Android + +If you need to use your own certificate for signing, you need to fill in the following: + +```ini +TAILCHAT_UPLOAD_STORE_FILE= +TAILCHAT_UPLOAD_STORE_PASSWORD= +TAILCHAT_UPLOAD_KEY_ALIAS= +TAILCHAT_UPLOAD_KEY_PASSWORD= +``` + +Need to fill in: certificate file name, password, alias, alias password +The certificate file needs to be placed in the `client/mobile/android/app` directory, usually a `*.keystore` file + +> As for how to generate it, you can use `Android Studio` or `keytool` tool to generate it. + +### iOS + +TODO + +## Push + +`Tailchat` implements Android multi-vendor message push by integrating personal tweets as a relay + +You can get all the required configuration in the application configuration of `getui` + +Among them `GETUI_APPID`, `GETUI_APPKEY`, `GETUI_APPSECRET` are filled in in order + +Corresponding configuration is required on the server side `GETUI_APPID`, `GETUI_APPKEY`, `GETUI_MASTERSECRET` so that the self-deployed push service can send push messages correctly + +![](/img/misc/getui.png) + +### Manufacturer Push + +Manufacturer push can be turned on or off as needed + +The source code needs to be modified as follows: +- `manifestPlaceholders` section and `dependencies` section of `client/mobile/android/app/build.gradle` +- `.env` environment variable configuration + + +## Compile + +### Android + +```bash +cd android +./gradlew assembleRelease +``` + +### iOS + +iOS compilation needs to be done through `xcode` + +> Screenshot cannot be taken due to lack of equipment, please follow the public information on the Internet. + +### FAQ + +If the following types of errors occur: + +``` +error Failed to install the app. Make sure you have the Android development environment set up: https://reactnative.dev/docs/environment-setup. +Error: Command failed: gradlew.bat app:installDebug -PreactNativeDevServerPort=8081 + +FAILURE: Build failed with an exception. + +* What went wrong: +Could not determine the dependencies of task ':app:compileDebugJavaWithJavac'. +> Could not resolve all dependencies for configuration ':app:debugRuntimeClasspath'. + > Could not create task ':app:generateDebugLintModel'. + > java.lang.NullPointerException (no error message) + +* Try: +> Run with --stacktrace option to get the stack trace. +> Run with --info or --debug option to get more log output. +> Run with --scan to get full insights. + +* Get more help at https://help.gradle.org + +BUILD FAILED in 27s +``` + +It may be because your environment variable is missing, you can leave the value empty, but the entry must exist + +like: +```ini +GETUI_APPID=xxxxxxxxxxxx +GETUI_APPKEY=yyyyyyyyy +GETUI_APPSECRET=zzzzzzzzzz +GETUI_HUAWEI_APP_ID= +``` + +instead of + +```ini +GETUI_APPID=xxxxxxxxxxxx +GETUI_APPKEY=yyyyyyyyy +GETUI_APPSECRET=zzzzzzzzzz +``` + +#### Can I compile it myself and publish it to the app store? + +Yes, but please modify the application name, package name, icon and other information to prevent conflicts with official applications. diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/mobile.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/mobile.md new file mode 100644 index 00000000..78a2cf34 --- /dev/null +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/deployment/mobile.md @@ -0,0 +1,155 @@ +--- +sidebar_position: 12 +title: 移动端自编译(可选) +--- + +`Tailchat` 移动端的源码位于 `client/mobile`. 技术栈为 `react-native` + +你可以直接在官网中下载已经编译好的通用版本: [https://tailchat.msgbyte.com/downloads](https://tailchat.msgbyte.com/downloads)，或者自行通过源码编译 + +本节内容主要就是讲解如何对 `Tailchat` 的移动端进行编译。 + +## 准备开发环境 + +你可以在 [https://reactnative.dev/docs/environment-setup](https://reactnative.dev/docs/environment-setup) 看到完整的开发环境准备操作，这里就不再赘述。 + +### 安装依赖 + +```bash +cd client/mobile +yarn +``` + +### 环境检查 + +```bash +yarn doctor +``` + +## 准备环境变量 + +```bash +cp .env.example .env +``` + +在 `.env` 文件中我们来配置所需的环境变量用于编译 + +```ini +TAILCHAT_UPLOAD_STORE_FILE= +TAILCHAT_UPLOAD_STORE_PASSWORD= +TAILCHAT_UPLOAD_KEY_ALIAS= +TAILCHAT_UPLOAD_KEY_PASSWORD= + +GETUI_APPID= +GETUI_APPKEY= +GETUI_APPSECRET= +GETUI_HUAWEI_APP_ID= +``` + +## 证书签名 + +如果仅用于测试，则可以跳过本节内容，Tailchat 会为你使用公开测试证书进行签名 + +### Android + +如果需要使用你自己的证书进行签名，你需要填入以下内容: + +```ini +TAILCHAT_UPLOAD_STORE_FILE= +TAILCHAT_UPLOAD_STORE_PASSWORD= +TAILCHAT_UPLOAD_KEY_ALIAS= +TAILCHAT_UPLOAD_KEY_PASSWORD= +``` + +需要依次填入: 证书文件名、密码、别名、别名密码 +证书文件需要放在`client/mobile/android/app`目录下，一般是 `*.keystore` 文件 + +> 至于具体如何生成，你可以使用 `Android Studio` 或者 `keytool` 工具来生成，这个有很多公开资料就不在此赘述了 + +### iOS + +TODO + +## 推送 + +`Tailchat` 通过集成个推作为中转来实现安卓多厂商的消息推送 + +你可以在 `getui` 的应用配置中获得所有所需要的配置 + +其中 `GETUI_APPID`, `GETUI_APPKEY`, `GETUI_APPSECRET` 依次填入 + +在服务端需要对应配置 `GETUI_APPID`, `GETUI_APPKEY`, `GETUI_MASTERSECRET` 来使自部署的推送服务能正确发送推送 + +![](/img/misc/getui.png) + +### 厂商推送 + +厂商推送可以按需打开或者关闭 + +需要修改源码如下: +- `client/mobile/android/app/build.gradle` 的 `manifestPlaceholders` 部分 和 `dependencies` 部分 +- `.env` 环境变量配置 + + +## 编译 + +### 安卓 + +```bash +cd android +./gradlew assembleRelease +``` + +### iOS + +iOS 编译需要通过 `xcode` 进行操作 + +> 因为缺少设备无法截图，请按照网络上公开资料进行操作即可 + +### 常见问题 + +如果出现以下类型的报错: + +``` +error Failed to install the app. Make sure you have the Android development environment set up: https://reactnative.dev/docs/environment-setup. +Error: Command failed: gradlew.bat app:installDebug -PreactNativeDevServerPort=8081 + +FAILURE: Build failed with an exception. + +* What went wrong: +Could not determine the dependencies of task ':app:compileDebugJavaWithJavac'. +> Could not resolve all dependencies for configuration ':app:debugRuntimeClasspath'. + > Could not create task ':app:generateDebugLintModel'. + > java.lang.NullPointerException (no error message) + +* Try: +> Run with --stacktrace option to get the stack trace. +> Run with --info or --debug option to get more log output. +> Run with --scan to get full insights. + +* Get more help at https://help.gradle.org + +BUILD FAILED in 27s +``` + +可能是因为你的环境变量有缺失, 你可以保留值为空，但该条目必须存在 + +如: +```ini +GETUI_APPID=xxxxxxxxxxxx +GETUI_APPKEY=yyyyyyyyy +GETUI_APPSECRET=zzzzzzzzzz +GETUI_HUAWEI_APP_ID= +``` + +而不是 + +```ini +GETUI_APPID=xxxxxxxxxxxx +GETUI_APPKEY=yyyyyyyyy +GETUI_APPSECRET=zzzzzzzzzz +``` + +#### 我能自己编译后发布到应用商店么 + +可以，但是请修改应用的名称、包名、图标等信息防止与官方应用冲突 diff --git a/website/static/img/misc/getui.png b/website/static/img/misc/getui.png new file mode 100644 index 00000000..a1605606 Binary files /dev/null and b/website/static/img/misc/getui.png differ