diff --git a/README.en-US.md b/README.en-US.md deleted file mode 100644 index 4bea683bfcba88bf5a413fdc8d2625053a458640..0000000000000000000000000000000000000000 --- a/README.en-US.md +++ /dev/null @@ -1,47 +0,0 @@ -

- - OpenTiny Logo - -

-

TinyEngine enables developers to customize low-code platforms, build low-bit platforms online in real time, and support secondary development or integration of low-bit platform capabilities.

- - -English | [简体中文](README.zh-CN.md) - -### development -Dependencies required for installation - -``` -$ npm install -``` -Local development configuration -*https://opentiny.design/tiny-engine#/help -center/course/backend/51 -Start a project -``` -$ npm run dev -``` -### Milestones - -```mermaid -gantt -dateFormat YYYY-MM-DD -axisFormat %Y-%m-%d - - 1.0.0-beta.x version :active,2023-09-25, 2024-03-31 - 1.0.0-rc version : 2024-04-01, 2024-06-30 - 1.0.0 version : 2024-07-01, 2024-07-31 - -``` - -### 🤝 Participating in contributions - -If you are interested in our open source project, please join us! - -Please read the Contribution Guide (CONTRIBUTING.zh-CN.md) before participating in the contribution. - -- Add official assistant WeChat opentiny-official and join the technical exchange group -- Join the mailing list opentiny@googlegroups.com - -### Open source protocol - -[MIT](LICENSE) diff --git a/README.md b/README.md index 4bea683bfcba88bf5a413fdc8d2625053a458640..9b7bc821b321730741620ed98f200156dcfceb7b 100644 --- a/README.md +++ b/README.md @@ -3,23 +3,54 @@ OpenTiny Logo

-

TinyEngine enables developers to customize low-code platforms, build low-bit platforms online in real time, and support secondary development or integration of low-bit platform capabilities.

+

TinyEngine Data Center, also known as the data center, uses the strAPI ORM data management open source framework to provide data services to TinyEngine Web Service by encapsulating the API for basic operations on data tables

English | [简体中文](README.zh-CN.md) +### Instruction Manual + +For specific server usage documentation, please see [TinyEngine Official Website - User Manual](https://opentiny.design/tiny-engine#/help-center/course/backend/51) + ### development -Dependencies required for installation +#### Environment variables + +|Variable name|Description| +|---|---| +|MYSQL_HOST|mysql service ip address| +|MYSQL_PORT|The mysql service port, default 3306| +|MYSQL_DBNAME|mysql service database name| +|MYSQL_PASSWORD|mysql service password| + +If Redis is used, the configuration example is as follows: + +|Variable name|Description| +|---|---| +|REDIS_HOST|Redis service ip address| +|REDIS_PORT|The redis service port, default 6380| +|RADIS_PASSWORD|Redis service password| +|REDIS_DB|The number of the Redis database connection, default 2| + +#### Local Runtime Configuration Method: + +git-bash or bash +``` +vi ~/.bashrc ``` -$ npm install ``` -Local development configuration -*https://opentiny.design/tiny-engine#/help -center/course/backend/51 -Start a project +export MQ_IP=192.168.0.11 +export MQ_PORT=5671 +# Wait for environment variables ``` -$ npm run dev +After setting, reopen the command line or execute it in the current command line ``` +source ~/.bashrc +``` +Make the set environment variables take effect;(The environment variables set in git bash cannot be applied to powershell and cmd) +Start project +Go to the root directory of the project and execute it in sequence + ### Milestones ```mermaid diff --git a/README.zh-CN.md b/README.zh-CN.md index e284d95b4bbffa83ca82709d8902a80473275157..bdcc3eefdcf4f1892ee3278f850e9b50a4a065f1 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -4,24 +4,61 @@

-

TinyEngine低代码引擎使能开发者定制低代码平台,支持在线实时构建低码平台,支持二次开发或集成低码平台能力

+

TinyEngine Data Center,也称为数据中心,使用strAPI ORM数据管理开源框架,通过封装API对数据表进行基本操作,为TinyEngine Web Service提供数据服务

[English](README.md) | 简体中文 +### 使用手册 + +具体服务端使用文档请查看[TinyEngine 官网-使用手册](https://opentiny.design/tiny-engine#/help-center/course/backend/51) + ### 开发 -安装所需的依赖 +#### 环境变量 + +|变量名称|说明 +|---|---| +|MYSQL_HOST|mysql服务ip地址| +|MYSQL_PORT|mysql服务端口,默认 3306| +|MYSQL_DBNAME|mysql服务数据库名称| +|MYSQL_PASSWORD|mysql服务密码| + +如果使用了redis, 配置示例如下: + +|变量名称|说明 +|---|---| +|REDIS_HOST|redis服务ip地址| +|REDIS_PORT|redis服务端口,默认 6380| +|RADIS_PASSWORD|redis服务密码| +|REDIS_DB|redis连接的存储区编号, 默认 2| + +## 本地运行时配置方式: + +git-bash 或 bash ``` -$ npm install +vi ~/.bashrc ``` -本地开发配置 -* https://opentiny.design/tiny-engine#/help-center/course/backend/51 +``` +export MQ_IP=192.168.0.11 +export MQ_PORT=5671 +# 等等环境变量 +``` +设置完后,重新打开命令行或则在当前命令行执行 +``` +source ~/.bashrc +``` +让设置的环境变量生效;(git bash中设置的环境变量无法适用于powershell 和cmd) 启动项目 +进入到项目根目录下,依次执行 + ``` -$ npm run dev +yarn install --ignore-engines +npm run build +npm run dev ``` ### 里程碑 + ```mermaid gantt dateFormat YYYY-MM-DD