# marsview

**Repository Path**: yangshare/marsview

## Basic Information

- **Project Name**: marsview
- **Description**: Marsview 是一款中后台方向的低代码可视化搭建平台，开发者可以在平台上创建项目、页面和组件，支持事件交互、接口调用、数据联动和逻辑编排等，开发者还可通过微前端框架 microApp 快速集成到自己的业务系统中
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2024-10-25
- **Last Updated**: 2025-01-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

<a href="http://marsview.cc/"><img src="https://marsview.cdn.bcebos.com/mars-logo.png" width="150" alt="marsview logo"></a>

# Marsview 低代码平台

让搭建更简单，让开发更高效

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

</div>

<div align="center">

![GitHub Repo stars](https://img.shields.io/github/stars/JackySoft/marsview)

![GitHub package.json version](https://img.shields.io/github/package-json/v/JackySoft/marsview)
![GitHub License](https://img.shields.io/github/license/JackySoft/marsview)
![version](https://img.shields.io/npm/v/amis)
![language](https://img.shields.io/github/languages/top/JackySoft/marsview)
![last](https://img.shields.io/github/last-commit/JackySoft/marsview.svg)

[English](./README.md) | 中文

</div>

## 介绍 🚀

Marsview 是一款中后台方向的低代码可视化搭建平台，开发者可以在平台上创建项目、页面和组件，支持事件交互、接口调用、数据联动和逻辑编排等，开发者还可通过微前端框架 microApp 快速集成到自己的业务系统中。

## 在线使用 🛸

- 🌍 [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) |

## 特色 💥

- **项目：**
  项目配置（主题色、菜单布局、系统 Logo、面包屑...）、完整的 RBAC 的权限管理。
- **页面：** 页面创建、页面主题、页面配置、组件拖拽、样式配置、事件流配置、逻辑编排、接口配置。
  页面支持通过微服务的方式集成到传统项目中，无论你是 Vue 还是 React。
- **权限：** 项目和页面支持开发者和访问者权限配置，项目还支持菜单、按钮级别的 RBAC 控制。
- **自定义组件：** 当平台提供的组件满足不了需求时，可以自定义开发业务组件，平台会在线编译，上传到云端，同时在编辑器界面自定义组件中可以点击进行加载。
- **接口：** 接口统一管理，全局拦截器、返回结构修改等。支持 GET、POST、PUT、DELETE 等请求方式，支持接口动态参数传递。
- **事件流：** 通过事件流可以完成高难度的业务逻辑编排，比如：组件联动、组件显隐、组件禁用、自定义逻辑处理、接口调用、路由跳转等。
- **环境：** 平台支持三套环境，STG、PRE 和 PRD，页面只有发布到对应环境后，才可以在用户端访问到该页面。
- **回滚：** 平台发布后的页面支持一键回滚。
- **微服务：** 如果你是传统的 Vue 项目，想使用此平台，可以先在平台搭建一个页面发布到 PRD 环境，最后通过微服务集成进来。
- 后端提供 JAVA 和 Koa 两个版本，数据库为 Mysql。

## 本地开发 👨‍💻

```bash
# 克隆代码
git clone https://github.com/JackySoft/marsview.git
```

项目说明

| 目录               | 说明                       |
| ------------------ | -------------------------- |
| packges            | 前端项目，包括 4 个子服务  |
| packges/admin      | 项目访问端                 |
| 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

pnpm i

pnpm run dev
```

> 注意：运行前需要修改 koa/config.js 配置文件。

3. 启动前端

```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

### 同步代码

项目处于高速开发阶段，版本更新较快，建议开发者 `fork` 和 `clone` 项目后，设置上流远程分支，随时拉取最新代码同步本地。

```bash
# 添加上流分支

git remote add upstream https://github.com/JackySoft/marsview

# 抓取源仓库修改 main 分支

git fetch upstream main

# 切换分支

git checkout main

# 合并远程分支

git merge upstream/main
```

## 活动记录 🆕

- 2024-10-30: Marsview 开源后端服务。
- 2024-09-27: 上线邮箱注册服务。
- 2024-08-30: MarsView 发布在[阮一峰周刊](https://www.ruanyifeng.com/blog/2024/08/weekly-issue-315.html)
- 2024-08-27: MarsAI v1.0 上线，在自定义编写中实现辅助生成代码
- 2024-08-17: 项目[在线文档](http://docs.marsview.cc/)发布
- 2024-08-13: 开源文章登上掘金论坛热榜第一
- 2024-08-10: 项目开源
  - 公告项目开源，发布开源文章：[我的低代码平台 Marsview 终于开源了](https://juejin.cn/post/7401009128204894244)
- 2024-07-16: 项目首次在掘金论坛预告
  - 发布预告文章：[我花了 8 个月，做了一款高颜值零代码平台 Mars](https://juejin.cn/post/7392071348480835595)

## 更新日志 📅

查看 [更新日志](https://github.com/JackySoft/marsview/blob/master/CHANGELOG.md) 获取最新更新情况。

## 项目交流 🏘️

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

<img src="/.github/imgs/mywechat.jpg"  width="200">

## 参与捐赠 ✨

[请我喝杯咖啡 ☕️](https://afdian.com/a/marsview)

感谢以下兄弟的捐赠：

| 名称            | 头像                                                           |
| --------------- | -------------------------------------------------------------- |
| 物联网方案-肖工 | <img src="http://docs.marsview.cc/sponsor/3.png"  width="50">  |
| 🥕 二月贝弋 🥕  | <img src="http://docs.marsview.cc/sponsor/2.png"  width="50">  |
| 猩猩点灯        | <img src="http://docs.marsview.cc/sponsor/1.png"  width="50">  |
| 元次达          | <img src="http://docs.marsview.cc/sponsor/4.png"  width="50">  |
| IoT-Fast        | <img src="http://docs.marsview.cc/sponsor/5.png"  width="50">  |
| w10752842       | <img src="http://docs.marsview.cc/sponsor/6.png"  width="50">  |
| 朱红宾          | <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">  |

## 🤝 参与贡献

这个项目的存在感谢项目中所有的贡献者。

我们非常欢迎各种形式的贡献。如果你对贡献代码感兴趣，可以查看我们的 GitHub [Issues](https://github.com/JackySoft/marsview/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)，大展身手，向我们展示你的奇思妙想。

如何你想成为开发者，欢迎提交`PR`，提交`PR`规范请参考：[Pull Rquest](.github/PULL_REQUEST_TEMPLATE.md)

<a href="https://github.com/JackySoft/marsview/graphs/contributors" target="_blank">
<img src="https://contrib.rocks/image?repo=JackySoft/marsview">
</a>

## Star History 🌟

如果你发现此项目对你有所帮助，请考虑在 [GitHub](https://github.com/JackySoft/marsview) 上给它一个 ⭐️ !
<a href="https://github.com/JackySoft/marsview/stargazers" target="_blank" style="display: block" align="center">
<picture>

<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=JackySoft/marsview&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=JackySoft/marsview&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=JackySoft/marsview&type=Date" />
</picture>
</a>

## 许可证 📄

此项目根据 MIT 许可证授权 - 有关详细信息，请参阅 [LICENSE](https://github.com/JackySoft/marsview/blob/main/LICENSE) 文件。