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 9233735 commit 537c456
Show file tree
Hide file tree
Showing 15 changed files with 50 additions and 56 deletions.
Binary file removed .github/imgs/intro1.png
Binary file not shown.
Binary file removed .github/imgs/intro2.png
Binary file not shown.
Binary file removed .github/imgs/intro3.png
Binary file not shown.
Binary file removed .github/imgs/intro4.png
Binary file not shown.
Binary file removed .github/imgs/intro5.png
Binary file not shown.
Binary file removed .github/imgs/intro6.png
Binary file not shown.
Binary file removed .github/imgs/intro7.png
Binary file not shown.
Binary file removed .github/imgs/intro8.png
Binary file not shown.
Binary file removed .github/imgs/logo.png
Binary file not shown.
Binary file removed .github/imgs/mywechat.jpg
Binary file not shown.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Make building simpler and development more efficient

[Project documentation](http://docs.marsview.cc/) |
[Open source repository](https://github.com/JackySoft/marsview) |
[Communication group](./.github/imgs/mywechat.jpg)
[Communication group](https://imgcloud.cdn.bcebos.com/f35323e9a2625a85909cb6f02.png)

</div>

Expand Down Expand Up @@ -36,12 +36,12 @@ Marsview is a low code visualization platform for middle and backend development

- 🌍 [Marsview](http://www.marsview.cc/)

| | |
| ---------------------------------- | ---------------------------------- |
| ![Demo](./.github/imgs/intro1.png) | ![Demo](./.github/imgs/intro2.png) |
| ![Demo](./.github/imgs/intro3.png) | ![Demo](./.github/imgs/intro4.png) |
| ![Demo](./.github/imgs/intro5.png) | ![Demo](./.github/imgs/intro6.png) |
| ![Demo](./.github/imgs/intro7.png) | ![Demo](./.github/imgs/intro8.png) |
| | |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae37.png) | ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae38.png) |
| ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae39.png) | ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae3a.png) |
| ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae3b.png) | ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae3c.png) |
| ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae3d.png) | ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae3e.png) |

## Platform Features 💥

Expand Down Expand Up @@ -138,7 +138,7 @@ View [Update Log](https://github.com/JackySoft/marsview/blob/master/CHANGELOG.md

If you encounter any technical or commercial authorization issues during use, please feel free to contact me via WeChat:

<img src="/.github/imgs/mywechat.jpg" width="200">
<img src="https://imgcloud.cdn.bcebos.com/f35323e9a2625a85909cb6f02.png" width="200">

## Participate in donation ✨

Expand Down
16 changes: 8 additions & 8 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

[项目文档](http://docs.marsview.cc/) |
[开源仓库](https://github.com/JackySoft/marsview) |
[交流群](./.github/imgs/mywechat.jpg)
[交流群](https://imgcloud.cdn.bcebos.com/f35323e9a2625a85909cb6f02.png)

</div>

Expand All @@ -34,12 +34,12 @@ Marsview 是一款中后台方向的低代码可视化搭建平台,开发者

- 🌍 [Marsview](http://www.marsview.cc/)

| | |
| ---------------------------------- | ---------------------------------- |
| ![Demo](./.github/imgs/intro1.png) | ![Demo](./.github/imgs/intro2.png) |
| ![Demo](./.github/imgs/intro3.png) | ![Demo](./.github/imgs/intro4.png) |
| ![Demo](./.github/imgs/intro5.png) | ![Demo](./.github/imgs/intro6.png) |
| ![Demo](./.github/imgs/intro7.png) | ![Demo](./.github/imgs/intro8.png) |
| | |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae37.png) | ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae38.png) |
| ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae39.png) | ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae3a.png) |
| ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae3b.png) | ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae3c.png) |
| ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae3d.png) | ![Demo](https://imgcloud.cdn.bcebos.com/09d56ca14e47f7880d67bae3e.png) |

## 特色 💥

Expand Down Expand Up @@ -150,7 +150,7 @@ git merge upstream/main

在使用过程中,遇到任何技术问题或商用授权问题,都可微信联系我:

<img src="/.github/imgs/mywechat.jpg" width="200">
<img src="https://imgcloud.cdn.bcebos.com/f35323e9a2625a85909cb6f02.png" width="200">

## 参与捐赠 ✨

Expand Down
17 changes: 8 additions & 9 deletions packages/docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ export default defineConfig({
'script',
{},
`
var _hmt = _hmt || [];
(function() {
var hm = document.createElement("script");
hm.src = "https://hm.baidu.com/hm.js?e0b36c5433838f284c65581c1de9b9bd";
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(hm, s);
})();
`,
var _hmt = _hmt || [];
(function() {
var hm = document.createElement("script");
hm.src = "https://hm.baidu.com/hm.js?e0b36c5433838f284c65581c1de9b9bd";
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(hm, s);
})();
`,
],
],
lang: 'zh-CN',
Expand Down Expand Up @@ -99,7 +99,6 @@ var _hmt = _hmt || [];
link: '/team',
},
],

socialLinks: [{ icon: 'github', link: 'https://github.com/JackySoft/marsview' }],
footer: {
message: 'Released under the MIT License.',
Expand Down
55 changes: 25 additions & 30 deletions packages/docs/src/deploy-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,35 +33,7 @@

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

5. 修改 `application.yml` 配置文件的 `eamil``redis``mybatis` 连接信息

```java
spring:
#邮箱配置
mail:
host:smtp地址,例如:smtp.qq.com
username:demo@qq.com(换成自己的邮箱)
password:yitmkgakdggbbceg(qq邮箱开启服务生成的密文,注意不是qq密码)
# redis配置
data:
redis:
host: XXXX
port: XXXX
password: XXXX
database: XXXX

#mybatis配置
mybatis:
jdbc:
url:XXXX
username: XXXX
password: XXXX

```

6. 运行 com.xintr.LowcodeApplication 启动服务

> 注意,邮箱必须是自己的 163 邮箱,并且开启 POP3 服务,否则无法发送验证码
详细文档请参考:[Java 启动和部署文档](https://github.com/JackySoft/marsview-backend/blob/main/java/README.md)

### koa 版本启动:

Expand Down Expand Up @@ -191,6 +163,11 @@ http://127.0.0.1:8080

启动后,即可在浏览器访问`Marsview`编辑器项目。

**注意:**
此时本地访问的项目地址是`admin.marsview.cc`,如果想要跳转到本地,需要修改`packages/editor/.env.development`文件中的`VITE_ADMIN_URL`,改为用户端启动后的地址。

线上部署时,同样需要修改`packages/editor/.env.production`文件中的`VITE_ADMIN_URL`

## 前端用户端启动

用户端主要用来访问搭建好的项目或者页面,但前提是页面必须已经发布到对应的环境中。
Expand Down Expand Up @@ -222,6 +199,24 @@ pnpm start:admin

http://127.0.0.1:8090

**注意:**
此时本地访问的项目地址是`admin.marsview.cc`,如果想要跳转到本地,需要修改`packages/admin/.env.development`文件中的`VITE_ADMIN_URL`,改为用户端启动后的地址。

线上部署时,同样需要修改`packages/admin/.env.production`文件中的`VITE_ADMIN_URL`

## 总结

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

2. `Java` 版本支持阿里云配置,`Koa`版本只支持百度云配置。

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

4. 线上部署需要关注`.env.production`文件配置,同时线上`nginx`需要添加反向代理。

```shell
# 通过反向代理可以解决跨域问题。
location ^~/api {
proxy_pass http://106.xx.xx.xx:9001;
}
```
2 changes: 1 addition & 1 deletion packages/docs/src/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ Marsview 是一款中后台方向的低代码可视化搭建平台,**面向前

可添加我个人微信,备注:`Marsview` 我会拉你进群。

![菜单关联页面](/my_qrcode.jpg)
<img src="/my_qrcode.jpg" width="200" height="200" />

0 comments on commit 537c456

Please sign in to comment.