feat: 添加中英文readme

JackySoft · Dec 18, 2024 · 1690a74 · 1690a74
1 parent 885f01a
commit 1690a74
Show file tree

Hide file tree

Showing 2 changed files with 263 additions and 48 deletions.
diff --git a/README.md b/README.md
@@ -2,13 +2,13 @@
 
 <a href="http://marsview.cc/"><img src="https://marsview.cdn.bcebos.com/mars-logo.png" width="150" alt="marsview logo"></a>
 
-# Marsview 低代码平台
+# Marsview Low Code Platform
 
-让搭建更简单，让开发更高效
+Make building simpler and development more efficient
 
-[项目文档](http://docs.marsview.cc/) |
-[开源仓库](https://github.com/JackySoft/marsview) |
-[交流群](https://marsview.cdn.bcebos.com/qrcode.jpg)
+[Project documentation](http://docs.marsview.cc/) |
+[Open source repository](https://github.com/JackySoft/marsview) |
+[Communication group](https://marsview.cdn.bcebos.com/qrcode.jpg)
 
 </div>
 
@@ -22,13 +22,17 @@
 ![language](https://img.shields.io/github/languages/top/JackySoft/marsview)
 ![last](https://img.shields.io/github/last-commit/JackySoft/marsview.svg)
 
+English | [中文](./README.zh-CN.md)
+
 </div>
 
-## 介绍 🚀
+## Intro 🚀
+
+Marsview is a low code visualization platform for middle and backend development. Developers can create projects, pages, and components on the platform, supporting event interaction, interface calling, data linkage, and logical orchestration. Developers can also quickly integrate them into their own business systems through the microApp front-end framework.
 
-Marsview 是一款中后台方向的低代码可视化搭建平台，开发者可以在平台上创建项目、页面和组件，支持事件交互、接口调用、数据联动和逻辑编排等，开发者还可通过微服务快速集成到自己的业务系统中。
+> > > > > > > 4ac0c61 (feat: 添加中英文 readme)
 
-## 在线使用 🛸
+## Online use 🛸
 
 - 🌍 [Marsview](http://www.marsview.cc/)
 
@@ -39,66 +43,69 @@ Marsview 是一款中后台方向的低代码可视化搭建平台，开发者
 | ![Demo](./.github/imgs/intro5.png) | ![Demo](./.github/imgs/intro6.png) |
 | ![Demo](./.github/imgs/intro7.png) | ![Demo](./.github/imgs/intro8.png) |
 
-## 特色 💥
+## Platform Features 💥
 
-- **项目：**
-  项目配置（主题色、菜单布局、系统 Logo、面包屑...）、完整的 RBAC 的权限管理。
-- **页面：** 页面创建、页面主题、页面配置、组件拖拽、样式配置、事件流配置、逻辑编排、接口配置。
-  页面支持通过微服务的方式集成到传统项目中，无论你是 Vue 还是 React。
-- **权限：** 项目和页面支持开发者和访问者权限配置，项目还支持菜单、按钮级别的 RBAC 控制。
-- **自定义组件：** 当平台提供的组件满足不了需求时，可以自定义开发业务组件，平台会在线编译，上传到云端，同时在编辑器界面自定义组件中可以点击进行加载。
-- **接口：** 接口统一管理，全局拦截器、返回结构修改等。支持 GET、POST、PUT、DELETE 等请求方式，支持接口动态参数传递。
-- **事件流：** 通过事件流可以完成高难度的业务逻辑编排，比如：组件联动、组件显隐、组件禁用、自定义逻辑处理、接口调用、路由跳转等。
-- **环境：** 平台支持三套环境，STG、PRE 和 PRD，页面只有发布到对应环境后，才可以在用户端访问到该页面。
-- **回滚：** 平台发布后的页面支持一键回滚。
-- **微服务：** 如果你是传统的 Vue 项目，想使用此平台，可以先在平台搭建一个页面发布到 PRD 环境，最后通过微服务集成进来。
+- **project:**
+  Project configuration (theme color, menu layout, system logo, breadcrumbs...), complete RBAC permission management.
+- **page:** Page creation, page theme, page configuration, component drag and drop, style configuration, event flow configuration, logical orchestration, interface configuration.
+  The page supports integration into traditional projects through microservices, whether you are Vue or React.
+- **permission:** The project and page support developer and visitor permission configuration, and the project also supports RBAC control at the menu and button level.
+- **Custom Components:** When the components provided by the platform cannot meet the requirements, business components can be customized and developed. The platform will compile them online and upload them to the cloud. At the same time, in the editor interface, custom components can be loaded by clicking on them.
+- **interface:** Unified interface management, global interceptors, return structure modifications, etc. Support GET, POST, PUT, DELETE and other request methods, and support dynamic parameter passing through interfaces.
+- **event flow:** High difficulty business logic orchestration can be completed through event flow, such as component linkage, component visibility and concealment, component disabling, custom logic processing, interface calling, route jumping, etc.
+- **environment:** The platform supports three environments, STG, PRE, and PRD. The page can only be accessed on the user side after being published to the corresponding environment.
+- **rollback：** After the platform is released, the page supports one click rollback.
+- **Micro front-end integration:** If you are a traditional Vue project and want to use this platform, you can first build a page on the platform and publish it to the PRD environment, and finally integrate it through microservices.
+- The backend provides two versions, JAVA and Koa, with MySQL as the database.
+  > > > > > > > 4ac0c61 (feat: 添加中英文 readme)
 
-## 本地开发 👨‍💻
+## Local development 👨‍💻
 
 ```bash
-# 克隆代码
 git clone https://github.com/JackySoft/marsview.git
 ```
 
 ### 快速开始
 
-运行需要 node 环境，建议`node:18`以上版本。使用`pnpm`作为依赖管理工具，如未安装，请先执行安装命令`npm install -g pnpm`。
+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
 # 进入根目录
 cd marsview
 
-# 安装依赖（安装依赖时间如过长，请先配置镜像源）
+# Install dependencies (if the installation dependency time is too long, please configure the image source first)
 pnpm i
 # 启动编辑器
 pnpm start:editor
 # 启动用户端（用户端是当你页面搭建完成后，给用户提供独立访问的系统）
 pnpm start:admin
 ```
 
-### 同步代码
+> Note: Vite_SBASEAPI can also choose to use an online address,eg: VITE_BASE_API = http://mars-api.marsview.cc/api.
 
-项目处于高速开发阶段，版本更新较快，建议开发者 `fork` 和 `clone` 项目后，设置上流远程分支，随时拉取最新代码同步本地。
+### Synchronization Code
+
+The project is in a high-speed development stage with fast version updates. It is recommended that developers set up upstream remote branches after the fork and clone projects to pull the latest code and synchronize it locally at any time.
 
 ```bash
-# 添加上流分支
+# add upstream
 
 git remote add upstream https://github.com/JackySoft/marsview
 
-# 抓取源仓库修改 master 分支
+# Capture the source repository and modify the main branch
 
 git fetch upstream main
 
-# 切换分支
+# Switch Branch
 
 git checkout main
 
-# 合并远程分支
+# Merge remote branches
 
 git merge upstream/main
 ```
 
-## 活动记录 🆕
+## Activities 🆕
 
 - 2024-08-30: MarsView 发布在[阮一峰周刊](https://www.ruanyifeng.com/blog/2024/08/weekly-issue-315.html)
 - 2024-08-27: MarsAI v1.0 上线，在自定义编写中实现辅助生成代码
@@ -107,25 +114,35 @@ git merge upstream/main
 - 2024-08-10: 项目开源
   - 公告项目开源，发布开源文章：[我的低代码平台 Marsview 终于开源了](https://juejin.cn/post/7401009128204894244)
 - 2024-07-16: 项目首次在掘金论坛预告
-  - 发布预告文章：[我花了 8 个月，做了一款高颜值零代码平台 Mars](https://juejin.cn/post/7392071348480835595)
+  - # 发布预告文章：[我花了 8 个月，做了一款高颜值零代码平台 Mars](https://juejin.cn/post/7392071348480835595)
+- 2024-10-30: Marsview open-source backend service.
+- 2024-09-27: Online email registration service.
+- 2024-08-30: MarsView Published in [Ruan Yifeng Weekly](https://www.ruanyifeng.com/blog/2024/08/weekly-issue-315.html)
+- 2024-08-27: MarsAI v1.0 is launched, and auxiliary code generation is implemented in custom writing.
+- 2024-08-17: Project [Online Document](http://docs.marsview.cc/) Publish.
+- 2024-08-13: Open source article ranks first on the hot list of the Gold Mining Forum.
+- 2024-08-10: Project open source
+  - Announce project open source, publish open source article: [My low code platform Marsview is finally open source](https://juejin.cn/post/7401009128204894244)
+- 2024-07-16: The project is previewed for the first time on the Gold Mining Forum
+  - Release trailer article: [I spent 8 months creating a high-quality zero code platform called Mars](https://juejin.cn/post/7392071348480835595)
 
-## 更新日志 📅
+## Update log 📅
 
-查看 [更新日志](https://github.com/JackySoft/marsview/blob/master/CHANGELOG.md) 获取最新更新情况。
+View [Update Log](https://github.com/JackySoft/marsview/blob/master/CHANGELOG.md) Get the latest updates.
 
-## 项目交流 🏘️
+## Project communication 🏘️
 
-在使用和开发过程中遇到任何问题，欢迎微信扫码添加项目交流群：
+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">
 
-## 参与捐赠 ✨
+## Participate in donation ✨
 
-[请我喝杯咖啡 ☕️](https://afdian.com/a/marsview)
+[Please treat me to a cup of coffee ☕️](https://afdian.com/a/marsview)
 
-感谢以下兄弟的捐赠：
+Thank you to the following brothers for their donation:
 
-| 名称            | 头像                                                          |
+| name            | profile picture                                               |
 | --------------- | ------------------------------------------------------------- |
 | 物联网方案-肖工 | <img src="http://docs.marsview.cc/sponsor/3.png"  width="50"> |
 | 🥕 二月贝弋 🥕  | <img src="http://docs.marsview.cc/sponsor/2.png"  width="50"> |
@@ -135,21 +152,19 @@ git merge upstream/main
 | w10752842       | <img src="http://docs.marsview.cc/sponsor/6.png"  width="50"> |
 | 朱红宾          | <img src="http://docs.marsview.cc/sponsor/7.png"  width="50"> |
 
-## 🤝 参与贡献
-
-这个项目的存在感谢项目中所有的贡献者。
+## 🤝 Participate and contribute
 
-我们非常欢迎各种形式的贡献。如果你对贡献代码感兴趣，可以查看我们的 GitHub [Issues](https://github.com/JackySoft/marsview/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)，大展身手，向我们展示你的奇思妙想。
+We warmly welcome contributions in various forms. If you are interested in contributing code, you can check out our GitHub [Issues](https://github.com/JackySoft/marsview/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc),Show us your creativity and creativity.
 
-如何你想成为开发者，欢迎提交`PR`，提交`PR`规范请参考：[Pull Rquest](.github/PULL_REQUEST_TEMPLATE.md)
+How do you want to become a developer? Welcome to submit `PR`. Please refer to the `PR` specification for submission: [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) 上给它一个 ⭐️ !
+If you find this project helpful to you, please consider [GitHub](https://github.com/JackySoft/marsview) Give it one ⭐️ !
 <a href="https://github.com/JackySoft/marsview/stargazers" target="_blank" style="display: block" align="center">
 <picture>
 
@@ -159,6 +174,6 @@ git merge upstream/main
 </picture>
 </a>
 
-## 许可证 📄
+## licence 📄
 
-此项目根据 MIT 许可证授权 - 有关详细信息，请参阅 [LICENSE](https://github.com/JackySoft/marsview/blob/main/LICENSE) 文件。
+This project is authorized under the MIT License - for more information, please refer to [LICENSE](https://github.com/JackySoft/marsview/blob/main/LICENSE) the document.