diff --git a/.eslintignore b/.eslintignore index a5f9925b3..f2ca21979 100644 --- a/.eslintignore +++ b/.eslintignore @@ -5,3 +5,4 @@ package-lock.json **/node_modules/** tmp temp +mockServer \ No newline at end of file diff --git a/.github/reviewers_for_configs.yml b/.github/reviewers_for_configs.yml new file mode 100644 index 000000000..dc01d068f --- /dev/null +++ b/.github/reviewers_for_configs.yml @@ -0,0 +1,42 @@ +# Set to true to add reviewers to pull requests +addReviewers: true + +# Set to true to add assignees to pull requests +addAssignees: true + +# A list of reviewers to be added to pull requests (GitHub user name) +reviewers: + - kagol + - wenmine + - zzcr + - kevinmoch + - lichunn + - lhuans + - chilingling + - yaoyun8 + - ianxinnew + - hexqi + - gargameljyh + + + +# A number of reviewers added to the pull request +# Set 0 to add all the reviewers (default: 0) +numberOfReviewers: 0 +# A list of assignees, overrides reviewers if set +assignees: + - kagol + - wenmine + - zzcr + - kevinmoch + - chilingling + - yaoyun8 + +# A number of assignees to add to the pull request +# Set to 0 to add all of the assignees. +# Uses numberOfReviewers if unset. +numberOfAssignees: 0 + +# A list of keywords to be skipped the process that add reviewers if pull requests include it +skipKeywords: + - wip \ No newline at end of file diff --git a/.github/workflows/add-review.yml b/.github/workflows/add-review.yml new file mode 100644 index 000000000..7da7e2c68 --- /dev/null +++ b/.github/workflows/add-review.yml @@ -0,0 +1,12 @@ +name: 'Auto Assign' +on: + pull_request: + types: [opened, ready_for_review] + +jobs: + add-reviews: + runs-on: ubuntu-latest + steps: + - uses: kentaro-m/auto-assign-action@v1.2.5 + with: + configuration-path: '../reviewers_for_configs.yml' \ No newline at end of file diff --git a/.github/workflows/push-check.yml b/.github/workflows/push-check.yml new file mode 100644 index 000000000..c0f2ca3bf --- /dev/null +++ b/.github/workflows/push-check.yml @@ -0,0 +1,33 @@ +name: CI + +on: + push: + branches: [] + pull_request: + branches: [develop,main] + +jobs: + push-check: + runs-on: ubuntu-latest # windows-latest || macos-latest + + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + node-version: 16 + - name: Get changed files + id: get_changed_files + uses: tj-actions/changed-files@v40 + with: + files: | + **.js + **.vue + **.jsx + - name: Install pnpm + run: npm i -g pnpm + - name: Install dependencies + run: pnpm i + - name: Run ESLint + run: npx eslint ${{steps.get_changed_files.outputs.all_changed_files}} + - name: Run Build + run: pnpm run build:plugin \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4a462f49c..3070a8cce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,14 +51,11 @@ Local startup steps: git clone git@github.com:username/tiny-engine.git cd tiny-engine git remote add upstream git@github.com:opentiny/tiny-engine.git -npm i +pnpm i # Start the project. -$ npm run serve +$ pnpm dev -# start another terminal -$ cd mockServer -$ npm run dev ``` To submit a PR: @@ -67,7 +64,7 @@ To submit a PR: - Local coding. - Submit according to [Commit Message Format](https://www.conventionalcommits.org/zh-hans/v1.0.0/) specification. PR that do not conform to the submission specification will not be merged. - Submit to remote repository: `git push origin branchName`. -- (Optional) Synchronize upstream repository dev branch latest code: `git pull upstream dev`. +- (Optional) Synchronize upstream repository dev branch latest code: `git pull upstream develop`. - Open the [Pull requests](https://github.com/opentiny/tiny-engine/pulls) link of the TinyEngine code repository and click the New pull request button to submit the PR. - Project Committer conducts Code Review and makes comments. - The PR author adjusts the code according to the opinion. Please note that when a branch initiates PR, the subsequent commit will be synchronized automatically, and there is no need to resubmit the PR. diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md index 171f91b22..4d411dfcf 100644 --- a/CONTRIBUTING.zh-CN.md +++ b/CONTRIBUTING.zh-CN.md @@ -42,23 +42,18 @@ - 点击 [TinyEngine](https://github.com/opentiny/tiny-engine) 代码仓库右上角的 Fork 按钮，将上游仓库 Fork 到个人仓库 - Clone 个人仓库到本地 -- 在 TinyEngine 根目录下运行 `npm install`, 安装依赖 -- 在 TinyEngine mockServer 运行 `npm install`, 安装依赖 -- 在 TinyEngine 根目录下运行 `npm run serve`，再到 mockServer 目录下运行 `npm run dev`，启动本地开发 +- 在 TinyEngine 根目录下运行 `pnpm i`, 安装依赖 +- 在 TinyEngine 根目录下运行 `pnpm dev`，启动本地开发 ```shell # username 为用户名，执行前请替换 git clone git@github.com:username/tiny-engine.git cd tiny-engine git remote add upstream git@github.com:opentiny/tiny-engine.git -npm i +pnpm i # 启动项目 -$ npm run serve - -# start another terminal -$ cd mockServer -$ npm run dev +$ pnpm dev ``` @@ -68,7 +63,7 @@ $ npm run dev - 本地编码 - 遵循 Commit Message Format 规范进行提交，不符合提交规范的 PR 将不会被合并 - 提交到远程仓库：git push origin branchName -- (可选)同步上游仓库 dev 分支最新代码：git pull upstream dev +- (可选)同步上游仓库 develop 分支最新代码：git pull upstream develop - 打开 TinyEngine 代码仓库的 [Pull requests](https://github.com/opentiny/tiny-engine/pulls) 链接，点击 New pull request 按钮提交 PR - 项目 Committer 进行 Code Review，并提出意见 - PR 作者根据意见调整代码，请注意一个分支发起了 PR 后，后续的 commit 会自动同步，无需重新提交 PR diff --git a/README.en-US.md b/README.en-US.md deleted file mode 100644 index 90d6690e6..000000000 --- a/README.en-US.md +++ /dev/null @@ -1,84 +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) - -🌈 Features: - -- Cross-end cross-frame front-end components -- Supports online real-time construction, secondary development, or being integrated. -- Directly generate deployable source code without engine support. -- Allows access to third-party components and customized extension plug-ins. -- Supports high-code and low-code, and hybrid development and deployment of applications. -- The platform accesses AI big model capabilities to help developers build applications. - -## Documentation - -- intro：https://opentiny.design/tiny-engine#/home -- tutorial：https://opentiny.design/tiny-engine#/help-center/course/engine -- playground：https://opentiny.design/tiny-engine#/tiny-engine-editor - -## Development - -### Dependencies required for installation - -```sh -$ pnpm install -``` - -### Local development: Start the local mock server and use the mock data of the local mock server. - -```sh -$ pnpm dev -``` - -Open a browser: `http://localhost:8080/?type=app&id=918&tenant=1&pageid=NTJ4MjvqoVj8OVsc` -`url search` Parameters: - -- `type=app` Application type -- `id=xxx` Application ID -- `tenant=xxx` Organization ID -- `pageid=xxx` Page ID - -## Build - -```sh -# Build all plug-ins first -pnpm build:plugin - -# Build Designer -pnpm build:alpha or build:prod - -``` - -## 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 - -``` - - -## 🤝 Participation and Contribution - -If you are interested in our open source project, please join us! 🎉 - -Please read the [Contribution Guide](CONTRIBUTING.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 - -## License - -[MIT](LICENSE) diff --git a/package.json b/package.json index 365ca8e21..d463591e8 100644 --- a/package.json +++ b/package.json @@ -12,6 +12,7 @@ "build:prod": "pnpm --filter @opentiny/tiny-engine build:prod", "buildComponentSchemas": "node scripts/buildComponentSchemas.js", "preview": "pnpm --filter @opentiny/tiny-engine preview", + "checkLint": "eslint . --ext .js,.vue,.jsx", "lint": "eslint . --ext .js,.vue,.jsx --fix", "format": "prettier --write **/*{.vue,.js,.ts,.html,.json}", "prepare": "node -e \"if(require('fs').existsSync('.git')){process.exit(1)}\" || husky install",