Skip to content

Commit

Permalink
docs: 修改文档
Browse files Browse the repository at this point in the history
  • Loading branch information
JackySoft authored and jianbing.chen committed Dec 18, 2024
1 parent 5cd17a1 commit 871d4f6
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 27 deletions.
34 changes: 10 additions & 24 deletions packages/docs/src/deploy-dev.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,25 @@
# 开发者本地启动

`Marsview` 包含前端和后端,数据库使用的是 `MySQL`如果后端采用`koa`需要提前安装 `Node``NPM`以及`PNPM`,如果后端采用`java`需要安装`jdk` `maven`
`Marsview` 包含前端和后端,数据库使用的是 `MySQL`后端使用`Node.js`开发,请提前安装 `Node``NPM`以及`PNPM`

## 仓库地址

1. 前端仓库:https://github.com/JackySoft/marsview
2. 后端仓库:https://github.com/JackySoft/marsview-backend

请部署的同学,动动小手,给项目点个`Star`,赠人玫瑰,手留余香,开源作者在此感谢。

## 数据库安装

1. 安装过程省略,请自行百度。

2. 创建数据库,名称随意,比如 `marsview`

3. 初始化数据库脚本,执行 `sql` 文件夹下的 `DDL_mars.sql` 脚本

> 如果后期数据库有脚本更新,我会把更新脚本放在`sql`文件夹的`更新说明.md`中。
3. 初始化数据库脚本,当前暂不开放,如有需要请向作者申请,并说明理由。

## 后端启动

后端提供 `JAVA``Koa` 两个版本。

### `java` 版本启动:

环境准备:`jdk` `mysql` `maven` `redis`

1. 安装 `jdk` 建议使用 `17` 及以上版本

2. 安装 `maven` 安装方式自行百度

3. 安装 `redis` 安装方式自行百度

4. 安装 `mysql` 安装方式自行百度

详细文档请参考:[Java 启动和部署文档](https://github.com/JackySoft/marsview-backend/blob/main/java/README.md)
后端当前只支持`Node`版本,其它语言如有需要,请自行实现。

### koa 版本启动:

Expand Down Expand Up @@ -140,15 +126,15 @@ pnpm i
proxy: {
'/api': {
// 如果本地启动后端,请替换为后端地址
target: 'http://localhost:5000',
target: 'http://mars-api.marsview.cc',
changeOrigin: true,
},
},
```

注意:

- `target`对应自己后端服务地址。`Java``Koa` 他们的默认端口不同,请对应修改
- `target`对应`Node`服务地址,默认连接线上服务
- 生产环境需要在`nginx`中添加反向代理。

3. 启动编辑器
Expand Down Expand Up @@ -180,13 +166,13 @@ http://127.0.0.1:8080
proxy: {
'/api': {
// 如果本地启动后端,请替换为后端地址
target: 'http://localhost:5000',
target: 'http://mars-api.marsview.cc',
changeOrigin: true,
},
},
```

- `target`对应自己后端服务地址。`Java``Koa` 他们的默认端口不同,请对应修改
- `target`对应`Node`服务地址,默认连接线上服务
- 生产环境需要在`nginx`中添加反向代理。

2. 启动用户端
Expand All @@ -208,7 +194,7 @@ http://127.0.0.1:8090

1. 以上是本地部署和启动的过程,由于项目依赖百度云`OSS``CDN`,所以没有百度云的同学,可能会导致图片云服务和自定义组件功能不可用。

2. `Java` 版本支持阿里云配置,`Koa`版本只支持百度云配置
2. 后端服务默认只支持`Node`版本

3. 本地部署时需要关注`.env.development`文件配置。

Expand Down
6 changes: 4 additions & 2 deletions packages/docs/src/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

### 打开 Marsview

输入平台地址:`https://marsview.cc`
输入平台地址:`https://www.marsview.com.cn`

> www.marsview.cc 近期会做域名备案,故请移步到新域名访问。
### 进入登录页面

Expand All @@ -12,4 +14,4 @@

### 登录账号

如果没有账号,可使用邮箱进行注册。
如果没有账号,可使用邮箱进行注册`30` 秒即可秒速登录
2 changes: 1 addition & 1 deletion packages/editor/src/pages/home/Template.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export default function Index() {
<>
<div className={styles.pagesContent}>
<Spin spinning={loading} size="large">
<PageCard list={content} getList={getList} />
<PageCard list={content} refresh={getList} />
</Spin>
</div>
<Pagination
Expand Down

0 comments on commit 871d4f6

Please sign in to comment.