diff --git a/README.md b/README.md index 2c583cf..a99c913 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/NetEase/tango) · [上游 README](https://github.com/NetEase/tango/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 +

-

Tango LowCode Builder

+

Tango 低代码设计器

-A source code based low-code builder. +一个源码驱动的低代码设计器框架 [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/NetEase/tango/blob/main/LICENSE) [![NPM version](https://img.shields.io/npm/v/@music163/tango-designer.svg?style=flat-square)](http://npmjs.org/package/@music163/tango-designer) @@ -14,112 +20,113 @@ A source code based low-code builder.
-English | [简体中文](/README.zh-CN.md) +简体中文 | [English](/README.md) -## 📄 Documentation +## 📄 文档 -You can view the detailed usage guide through the following links: +可以通过下面的链接查看详细的使用指南： -- Document site: -- Playground application: +- 官方文档站点: +- 演示应用: -## ✨ Features +## ✨ 特性 -- Tested in the production environment of NetEase Cloud Music, can be flexibly integrated into low-code platforms, local development tools, etc. -- Based on source code AST, with no private DSL and protocol - Real-time code generation capability, supporting source code in and source code out -- Out-of-the-box front-end low-code designer, providing flexible and easy-to-use designer React components -- Developed using TypeScript, providing complete type definition files +- 经历网易云音乐内网生产环境的实际检验，可灵活集成应用于低代码平台，本地开发工具等 +- 提供基于源码 AST 驱动的低代码引擎，无私有 DSL 和协议 +- 提供实时出码能力，支持源码进，源码出，适配多种源码开发场景 +- 提供开箱即用的前端低代码设计器，提供灵活易用的设计器 React 组件 +- 使用 TypeScript 开发，提供完整的类型定义文件和完善的文档支持 -## 💡 Examples +## 💡 例子 -You can use tango to build lowcode builders, for example: +你可以使用 Tango 快速构建多种类型的基于源码的低代码搭建工具，例如： -| Preview | Description | -| ---------------------------------------------------------------------------------------------- | ----------------------- | -| ![image](https://github.com/NetEase/tango/assets/6984035/56a71741-4536-4336-803a-d81d51128a76) | Internal App Builder | -| ![dashboard app](public/dashboard-builder.png) | Dashboard App Builder | -| ![image](https://github.com/NetEase/tango/assets/6984035/790d88e1-d716-4f99-868a-31dda25e9fb1) | Mobile App Builder | -| ![rn app](public/rn-builder.png) | ReactNative App Builder | -| ![mail app](public/mail-builder.png) | Email Builder | +| 预览图 | 说明 | +| ---------------------------------------------------------------------------------------------- | -------------------- | +| ![image](https://github.com/NetEase/tango/assets/6984035/56a71741-4536-4336-803a-d81d51128a76) | 中后台系统搭建 | +| ![dashboard app](public/dashboard-builder.png) | 仪表盘应用搭建 | +| ![image](https://github.com/NetEase/tango/assets/6984035/790d88e1-d716-4f99-868a-31dda25e9fb1) | H5活动页面搭建 | +| ![rn app](public/rn-builder.png) | ReactNative 应用搭建 | +| ![mail app](public/mail-builder.png) | 营销类邮件搭建 | -## 🌐 Compatibility +## 🌐 兼容环境 -- Modern browsers（Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions） +- 现代浏览器（Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions） -## 💻 Development +## 💻 开发 -### Environment +### 推荐开发环境 - Node `>= 18` - Yarn `>= 1.22 && < 2` -### Development Quick Start +### 本地开发调试方法 ```bash -# clone the repo +# 下载仓库 git clone https://github.com/NetEase/tango.git -# enter the project root +# 进入项目根目录 cd tango -# install dependencies +# 安装依赖 yarn -# start the designer playground app +# 启动设计器示例 yarn start ``` -### Local Https certificate +### 本地 https 证书 -If you need to use https in the local development environment, you can use the following command to generate a certificate: +如果需要在本地开发环境中使用 https，可以使用以下命令生成证书： ```bash brew install mkcert -# install the local certificate +# 将 mkcert 添加到本地根 CA，仅在本地生效 mkcert -install -# enter the playground app directory +# 进入 playground 应用目录 cd apps/playground -# generate a certificate -mkcert local.netease.com # or change to your own domain name +# 为网站生成一个由 mkcert 签名的证书 +mkcert local.netease.com ``` -## 💬 Community +## 💬 社区讨论 -Join NetEase Tango Community to share your ideas, suggestions, or questions and connect with other users and contributors. +参与 NetEase Tango 的社区，以分享您的想法、建议或问题，并与其他用户和贡献者建立联系。 - Discord: -- [Usage Trends](https://npm-compare.com/@music163/tango-helpers,@music163/tango-context,@music163/tango-core,@music163/tango-setting-form,@music163/tango-sandbox,@music163/tango-ui,@music163/tango-designer) +- [使用趋势](https://npm-compare.com/@music163/tango-helpers,@music163/tango-context,@music163/tango-core,@music163/tango-setting-form,@music163/tango-sandbox,@music163/tango-ui,@music163/tango-designer) -## 🤝 Contributing +## 🤝 参与共建 -Please read the [github contribution guide](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) first。 +请先阅读 [贡献指南](https://docs.github.com/en/get-started/quickstart/contributing-to-projects)。 -- Clone the repository -- Create a branch -- Commit and push your code -- Open a Pull Request +- 克隆仓库 +- 创建分支 +- 提交代码 +- 合并修改 git rebase master +- 发起 Pull Request -## 💗 Acknowledgments +## 💗 致谢 -Thanks to the NetEase Cloud Music Front-end team, Public Technology team, Live Broadcasting Technology team, and all the developers who participated in the Tango project. +感谢网易云音乐公共技术团队，大前端团队，直播技术团队，以及所有参与过 Tango 项目的开发者。 -Thank you to CodeSandbox for providing the [Sandpack](https://sandpack.codesandbox.io/) project, which provides powerful online code execution capabilities for Tango. +感谢 CodeSandbox 提供的 [Sandpack](https://sandpack.codesandbox.io/) 项目，为 Tango 提供了强大的基于浏览器的代码构建与执行能力。 -## 📣 Product Promotion +## 📣 产品推广 ![](https://p5.music.126.net/obj/wonDlsKUwrLClGjCm8Kx/31629770956/da9e/3a74/4e00/7c69cf46a713f1b008bd1243b5b1ab1c.png) -Don't waste your time restoring the UI, try the NetEase Cloud Music "Seal D2C" development tool! Easily turn your design into code, support React, RN, Vue, WeChat apps and other multi-end scenarios, what you see is what you get! +不要再浪费时间还原 UI 啦，快来试试网易云音乐「海豹 D2C」研发工具吧！轻松将设计稿转为代码，支持 React、RN、Vue、微信小程序等多端场景，所见即所得！ -Experience "Seal D2C" now: +立即体验「海豹 D2C」： -- I'm a Figma user: -- I'm a MasterGo user: +- 我是 Figma 用户： +- 我是 MasterGo 用户： -## 📄 License +## 📄 开源协议 -This project is licensed under the terms of the [MIT license](./LICENSE) +此项目遵循 [MIT 开源协议](./LICENSE)