Skip to content

Commit

Permalink
docs: 修改文档,增加捐赠者名单
Browse files Browse the repository at this point in the history
  • Loading branch information
JackySoft committed Nov 7, 2024
1 parent d533ddf commit 88d3005
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 42 deletions.
44 changes: 23 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ Marsview is a low code visualization platform for middle and backend development

## Local development 👨‍💻

### Frontend

```bash
git clone https://github.com/JackySoft/marsview.git
```
Expand All @@ -71,43 +73,42 @@ Project Description
| packges/editor | Editor end |
| packages/materials | Component materials, for admin use only |
| packages/docs | Low code usage documentation |
| backend | Backend services, including 2 versions |
| backend/java | JAVA version |
| backend/koa | Node version |
| backend/koa/config | Project configuration file |
| backend/sql | Database SQL Script |

### Quick start
### Backend

Running requires a node environment, it is recommended to have a version of 'node: 18' or higher. Use `pnpm` as a dependency management tool. If it is not installed, please execute the installation command `npm install - g pnpm` first.
```bash
git clone https://github.com/JackySoft/marsview-backend.git
```

1. Install MySQL database and execute the `backend/db. sql` script
Project Description
| directory | description |
| backend | Backend services, including 2 versions |
| backend/java | JAVA version |
| backend/koa | Node version |
| backend/koa/config | Project configuration file |
| backend/sql | Database SQL Script |

2. Start Node backend
### Deploy Documentation

```bash
cd backend/koa
[Documentation](http://docs.marsview.cc/deploy.html)

pnpm i

pnpm run dev
```
### Quick start

> Note: The koa/config. js configuration file needs to be modified before running.
Running requires a node environment, it is recommended to have a version of 'node: 18' or higher. Use `pnpm` as a dependency management tool. If it is not installed, please execute the installation command `npm install - g pnpm` first.

3. Start the front-end
1. Start the front-end

```bash

# Install dependencies (if the installation dependency time is too long, please configure the image source first)
pnpm i
# Modify the. env. development file
VITE_BASE_API = 'http://localhost:5000/api'
# 启动编辑器
# Launch Editor
pnpm start:editor
```

> Note: Vite_SBASEAPI can also choose to use an online address,eg: VITE_BASE_API = http://mars-api.marsview.cc/api.
> Note: By default, online interfaces are used. If private deployment is required, please refer to the private deployment documentation.
[Documentation](http://docs.marsview.cc/deploy.html)

### Synchronization Code

Expand Down Expand Up @@ -173,6 +174,7 @@ Thank you to the following brothers for their donation:
| 朱红宾 | <img src="http://docs.marsview.cc/sponsor/7.png" width="50"> |
| yangshare | <img src="http://docs.marsview.cc/sponsor/8.jpeg" width="50"> |
| Joker6578 | <img src="http://docs.marsview.cc/sponsor/9.png" width="50"> |
| xiaoqingbbbb | <img src="http://docs.marsview.cc/sponsor/11.png" width="50"> |

## 🤝 Participate and contribute

Expand Down
40 changes: 19 additions & 21 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ Marsview 是一款中后台方向的低代码可视化搭建平台,开发者

## 本地开发 👨‍💻

### 前端仓库

```bash
# 克隆代码
git clone https://github.com/JackySoft/marsview.git
Expand All @@ -72,43 +74,38 @@ git clone https://github.com/JackySoft/marsview.git
| packges/editor | 编辑器端 |
| packages/materials | 组件物料 ,仅供 admin 使用 |
| packages/docs | 低代码使用文档 |
| backend | 后端服务,包括 2 个版本 |
| backend/java | JAVA 版本 |
| backend/koa | KOA 版本 |
| backend/koa/config | 项目配置文件 |
| backend/sql | 数据库脚本 |

### 快速开始

运行需要 node 环境,建议`node:18`以上版本。使用`pnpm`作为依赖管理工具,如未安装,请先执行安装命令`npm install -g pnpm`

1. 安装 MySQL 数据库,执行`backend/db.sql`脚本

2. 启动 Node 后端
### 后端仓库

```bash
cd backend/koa
git clone https://github.com/JackySoft/marsview-backend.git
```

pnpm i
| 目录 | 说明 |
| ------------------ | ----------------------- |
| backend | 后端服务,包括 2 个版本 |
| backend/java | JAVA 版本 |
| backend/koa | KOA 版本 |
| backend/koa/config | 项目配置文件 |
| backend/sql | 数据库脚本 |

pnpm run dev
```
### 快速开始

> 注意:运行前需要修改 koa/config.js 配置文件
运行需要 node 环境,建议`node:18`以上版本。使用`pnpm`作为依赖管理工具,如未安装,请先执行安装命令`npm install -g pnpm`

3. 启动前端
1. 启动项目

```bash

# 安装依赖(安装依赖时间如过长,请先配置镜像源)
pnpm i
# 修改 .env.development 文件
VITE_BASE_API = 'http://localhost:5000/api'
# 启动编辑器
pnpm start:editor
```

> 注意:VITE_BASE_API 也可以选择使用在线地址,例如:VITE_BASE_API = http://mars-api.marsview.cc/api
> 注意:默认使用线上接口,如果需要私有化部署,请参考私有化部署文档。
[Documentation](http://docs.marsview.cc/deploy.html)

### 同步代码

Expand Down Expand Up @@ -173,6 +170,7 @@ git merge upstream/main
| 朱红宾 | <img src="http://docs.marsview.cc/sponsor/7.png" width="50"> |
| yangshare | <img src="http://docs.marsview.cc/sponsor/8.jpeg" width="50"> |
| Joker6578 | <img src="http://docs.marsview.cc/sponsor/9.png" width="50"> |
| xiaoqingbbbb | <img src="http://docs.marsview.cc/sponsor/11.png" width="50"> |

## 🤝 参与贡献

Expand Down
Binary file added packages/docs/src/public/sponsor/11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 88d3005

Please sign in to comment.