github/dootask
1
0
Fork 0
mirror of https://github.com/kuaifan/dootask.git synced 2025-12-11 02:12:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

perf: 更新说明文档

Browse Source
This commit is contained in:
kuaifan 2024-03-02 14:11:52 +08:00
parent 3556133585
commit 69ec57669e
4 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -2,7 +2,7 @@
English | **[中文文档](./README_CN.md)** English | **[中文文档](./README_CN.md)**
- [Screenshot Preview](README_PREVIEW.md) - [Screenshot preview](./README_PREVIEW.md)
- [Demo site](http://www.dootask.com/) - [Demo site](http://www.dootask.com/)
**QQ Group** **QQ Group**
@ -12,8 +12,9 @@ Group No.: `546574618`
## Setup ## Setup
- `Docker v20.10+` & `Docker Compose v2.0+` must be installed - `Docker v20.10+` & `Docker Compose v2.0+` must be installed
- System: `Centos/Debian/Ubuntu/macOS` - System: `Centos/Debian/Ubuntu/macOS/Windows`
- Hardware suggestion: 2 cores and above 4G memory - Hardware suggestion: 2 cores and above 4G memory
- Special note: Windows users please use `git bash` or `cmder` to run the command
### Deployment (Pro Edition) ### Deployment (Pro Edition)
@ -66,11 +67,13 @@ cd dootask
### Development compilation ### Development compilation
- `NodeJs 18+` must be installed
```bash ```bash
# Development mode, Mac OS only # Development
./cmd dev ./cmd dev
# Production projects, macOS only # Production (This is web client. For App/PC/Mac clients, Please read README-CLIENT.md)
./cmd prod ./cmd prod
``` ```

8
README_CLIENT.md
View File

@ -3,19 +3,23 @@
## 1、App客户端 ## 1、App客户端
#### 1.1、说明 #### 1.1、说明
目录 `resources/mobile`，使用`eeui.app`框架，遵从eeui的开发文档进行打包开发app 目录 `resources/mobile`，使用`eeui.app`框架，遵从eeui的开发文档进行打包开发app
#### 1.2、编译App #### 1.2、编译App
1. 在项目目录执行 `./cmd appbuild` 编译
1. 在项目目录执行 `./cmd appbuild [build|setting]` 编译
2. 进入 `resources/mobile` eeui框架内打包Android或iOS应用 2. 进入 `resources/mobile` eeui框架内打包Android或iOS应用
## 2、PC/Mac客户端 ## 2、PC/Mac客户端
#### 2.1、说明 #### 2.1、说明
目录 `electron`，使用`electron`框架，遵从electron的开发文档进行打包客户端 目录 `electron`，使用`electron`框架，遵从electron的开发文档进行打包客户端
#### 2.2、编译客户端 #### 2.2、编译客户端
在项目目录执行 `./cmd electron` 根据提示编译
在项目目录执行 `./cmd electron [dev]` 根据提示编译

11
README_CN.md
View File

@ -2,7 +2,7 @@
**[English](./README.md)** | 中文文档 **[English](./README.md)** | 中文文档
- [截图预览](README_PREVIEW.md) - [截图预览](./README_PREVIEW.md)
- [演示站点](http://www.dootask.com/) - [演示站点](http://www.dootask.com/)
**QQ交流群** **QQ交流群**
@ -12,8 +12,9 @@
## 安装程序 ## 安装程序
- 必须安装：`Docker v20.10+` 和 `Docker Compose v2.0+` - 必须安装：`Docker v20.10+` 和 `Docker Compose v2.0+`
- 支持环境：`Centos/Debian/Ubuntu/macOS` - 支持环境：`Centos/Debian/Ubuntu/macOS/Windows`
- 硬件建议：2核4G以上 - 硬件建议：2核4G以上
- 特别说明：Windows 用户请使用 `git bash` 或者 `cmder` 运行命令
### 部署项目（Pro版） ### 部署项目（Pro版）
@ -66,11 +67,13 @@ cd dootask
### 开发编译 ### 开发编译
- 请确保你已经安装了 `NodeJs 18+`
```bash ```bash
# 开发模式，仅限macOS # 开发模式
./cmd dev ./cmd dev
# 编译项目，仅限macOS # 编译项目（这是网页端的，App/Pc/Mac客户端请查看 README_CLIENT.md）
./cmd prod ./cmd prod
``` ```

2
README_PUBLISH.md
View File

@ -22,5 +22,5 @@
## 编译App ## 编译App
1. 执行 `./cmd appbuild` 或 `./cmd appbuild setting` 编译 1. 执行 `./cmd appbuild [setting]` 编译
2. 进入 `resources/mobile` eeui框架内打包Android或iOS应用 2. 进入 `resources/mobile` eeui框架内打包Android或iOS应用