Skip to content
This repository has been archived by the owner on Jan 10, 2025. It is now read-only.

Commit

Permalink
Optimize doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
BinChengZhao committed Jul 25, 2021
1 parent 88c3cba commit 8f6e5d7
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 25 deletions.
7 changes: 4 additions & 3 deletions README_zhCN.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ https://github.com/BinChengZhao/delicate)

- **高性能:** 轻量级和基本功能加快了性能,`delicate'的基本资源开销大约是(小于0.1%的cpu使用率,10m的内存.)

- **可观察性:**有许多有意义的统计数据定期以图表的方式展现。
- **可观察性:** 有许多有意义的统计数据定期以图表的方式展现。

- **升级:**系统的动态升级(升级是通过获得最新的源代码和进行数据库迁移.)
- **升级:** 系统的动态升级(升级是通过获得最新的源代码和进行数据库迁移.)

`Delicate` 架构图:

Expand All @@ -47,7 +47,8 @@ https://github.com/BinChengZhao/delicate)

## Get Started

`Delicate`的基本用途是为后端服务器和执行器快速设置。我们把它分成多个简单的步骤来说明`Delicate`的概念和操作.
如下是`Delicate` - `scheduler` & `executor` 的基本用途和快速设置。
我们把它分成多个简单的步骤来说明`Delicate`的概念和操作.

源码安装的依赖:
* [rustc](https://www.rust-lang.org/tools/install) (minimum-supported version of `rustc` is **1.49**.)
Expand Down
25 changes: 11 additions & 14 deletions delicate-web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ The front-end project of `delicate` is based on `antd-admin` development, thank

</div>

- Preview - [https://delicate-rs.com](https://delicate.com)

English | [简体中文](./docs/zh-cn/README.md)

Expand All @@ -43,40 +42,38 @@ sudo yarn install
sudo yarn build
```

3. Start local server.

```bash
sudo yarn start
```

4. After the startup is complete, open a browser and visit [http://localhost:7000](http://localhost:7000), If you need to change the startup port, you can configure it in the `.env` file, And you can set the backend request address in `delicate-web/src/utils/envConfig.js`.

5. Deploy:
3. Deploy:
Next, we can upload the static file to the server. If you use Nginx as the Web server, you can configure it in `ngnix.conf`:
```
server
{
listen 80;
# Specify an accessible domain name
server_name web.delicate-rs.com;
# The directory where the compiled files are stored
root /home/www/delicate-web/dist;
# Proxy server .
location / {
# Proxy delicate-scheduler server .
location /api {
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header Host $http_host;
proxy_pass http://127.0.0.1:7000;
proxy_pass http://*.*.*.*:8090;
}
Because the front end uses BrowserHistory, it will route backback to index.html
# Because the front end uses BrowserHistory, it will
# route back to index.html
location / {
index index.html;
try_files $uri $uri/ /index.html;
}
}
```

4. After the startup is complete, open a browser and visit [http://yourdomain.com](http://yourdomain.com), If you need to change the startup port, you can configure it in the `.env` file, And you can set the backend request address in `delicate-web/src/utils/envConfig.js`.



## Browsers support

Expand Down
2 changes: 1 addition & 1 deletion delicate-web/docs/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ server
# Proxy server interface to avoid cross-domain
location /api {
proxy_pass http://localhost:7000/api;
proxy_pass http://*.*.*.*:8090/api;
}
Because the front end uses BrowserHistory, it will route backback to index.html
Expand Down
39 changes: 33 additions & 6 deletions delicate-web/docs/zh-cn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<div align="center">

一个轻量的分布式的任务调度平台通过 rust & js 编写.
一个轻量的分布式的任务调度平台通过 rust & react 编写.

`delicate` 的前端项目是基于 "antd-admin "开发的,非常感谢各位。

Expand All @@ -23,7 +23,7 @@ https://github.com/BinChengZhao/delicate)
</div>


## 特性
## 前端特性

- 国际化,源码中抽离翻译字段,按需加载语言包
- 动态权限,不同权限对应不同菜单
Expand All @@ -49,13 +49,40 @@ sudo yarn install
sudo yarn build
```

3. 启动本地服务器。

```bash
sudo yarn start
3. 部署:
接下来,我们可以将静态文件上传到服务器。如果你使用Nginx作为Web服务器,你可以在`ngnix.conf`中配置它:

```
server
{
listen 80;
# Specify an accessible domain name
server_name web.delicate-rs.com;
# The directory where the compiled files are stored
root /home/www/delicate-web/dist;
# Proxy delicate-scheduler server .
location /api {
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header Host $http_host;
proxy_pass http://*.*.*.*:8090;
}
# Because the front end uses BrowserHistory, it will
# route back to index.html
location / {
index index.html;
try_files $uri $uri/ /index.html;
}
}
```

4. 启动完成后打开浏览器访问 [http://localhost:7000](http://localhost:7000),如果需要更改启动端口,可在 `.env` 文件中配置。
4. 启动完成后,打开浏览器,访问[http://yourdomain.com](http://yourdomain.com),如果你需要改变启动端口,可以在`.env`文件中配置,而且你可以在`delicate-web/src/utils/envConfig.js`中设置`delicate-scheduler`服务端的请求地址。.




> 更多信息请参考 。
Expand Down
2 changes: 1 addition & 1 deletion delicate-web/docs/zh-cn/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ server
# 代理服务端接口,避免跨域
location /api {
proxy_pass http://localhost:7000/api;
proxy_pass http://*.*.*.*:8090/api;
}
# 因为前端使用了BrowserHistory,所以将路由 fallback 到 index.html
Expand Down

0 comments on commit 8f6e5d7

Please sign in to comment.