forked from opentiny/tiny-engine
添加eslint&自动化构建 (#101)
This commit is contained in:
wenmine
GitHub
parent
6de244f098
commit
6a4de499a4
|
|
@ -5,3 +5,5 @@ package-lock.json
|
|||
**/node_modules/**
|
||||
tmp
|
||||
temp
|
||||
mockServer
|
||||
packages/vue-generator/**/output/**
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
English | [简体中文](https://github.com/opentiny/tiny-engine/blob/develop/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.zh-CN.md)
|
||||
|
||||
# PR
|
||||
|
||||
## PR Checklist
|
||||
|
|
@ -7,6 +9,7 @@ Please check if your PR fulfills the following requirements:
|
|||
- [ ] The commit message follows our [Commit Message Guidelines](https://github.com/opentiny/tiny-engine/blob/develop/CONTRIBUTING.md)
|
||||
- [ ] Tests for the changes have been added (for bug fixes / features)
|
||||
- [ ] Docs have been added / updated (for bug fixes / features)
|
||||
- [ ] Built its own designer, fully self-validated
|
||||
|
||||
## PR Type
|
||||
|
||||
|
|
@ -23,13 +26,21 @@ What kind of change does this PR introduce?
|
|||
- [ ] Documentation content changes
|
||||
- [ ] Other... Please describe:
|
||||
|
||||
## What is the current behavior?
|
||||
## Background and solution
|
||||
<!--
|
||||
1. Describe the problem and the scenario.
|
||||
2. New features need to be described and attached with renderings.
|
||||
3. Screenshots or GIFs involving UI/Interaction changes/Bugfix before and after modification are required.
|
||||
-->
|
||||
|
||||
### What is the current behavior?
|
||||
|
||||
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
|
||||
|
||||
Issue Number: N/A
|
||||
|
||||
## What is the new behavior?
|
||||
### What is the new behavior?
|
||||
|
||||
|
||||
## Does this PR introduce a breaking change?
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,52 @@
|
|||
[English](https://github.com/opentiny/tiny-engine/blob/develop/.github/PULL_REQUEST_TEMPLATE.md) | 简体中文
|
||||
|
||||
# PR
|
||||
|
||||
## PR Checklist
|
||||
|
||||
请检查您的 PR 是否满足以下要求：
|
||||
|
||||
- [ ] commit message遵循我们的[提交贡献指南](https://github.com/opentiny/tiny-engine/blob/develop/CONTRIBUTING.md)
|
||||
- [ ] 添加了更改内容的测试用例（用于bugfix/功能）
|
||||
- [ ] 文档已添加/更新（用于bugfix/功能）
|
||||
- [ ] 是否构建了自己的设计器，经过了充分的自验证
|
||||
|
||||
## PR 类型
|
||||
|
||||
这个PR的类型是？
|
||||
|
||||
- [ ] 日常 bug 修复
|
||||
- [ ] 新特性支持
|
||||
- [ ] 代码风格优化
|
||||
- [ ] 重构
|
||||
- [ ] 构建优化
|
||||
- [ ] 测试用例
|
||||
- [ ] 文档更新
|
||||
- [ ] 分支合并
|
||||
- [ ] 其他改动（请补充）
|
||||
|
||||
|
||||
## 需求背景和解决方案
|
||||
|
||||
<!--
|
||||
1. 要解决的具体问题。
|
||||
2. 新增特性，需要进行功能描述，并附上效果图。
|
||||
3. 涉及UI/交互变动/Bugfix需要有修改前&修改后截图或 GIF。
|
||||
-->
|
||||
|
||||
|
||||
Issue Number: N/A
|
||||
|
||||
### 修改前
|
||||
|
||||
|
||||
### 修改后
|
||||
|
||||
## 此PR是否含有 breaking change?
|
||||
|
||||
- [ ] 是
|
||||
- [ ] 否
|
||||
|
||||
<!-- 如果此 PR 包含breaking change，请在下面从用户角度描述具体变化和其他风险。-->
|
||||
|
||||
## Other information
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
name: Push And Create PR Check
|
||||
|
||||
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: Install pnpm
|
||||
run: npm i -g pnpm
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm i
|
||||
|
||||
- name: Get changed files
|
||||
id: get_changed_files
|
||||
uses: tj-actions/changed-files@v40
|
||||
with:
|
||||
files: |
|
||||
**.js
|
||||
**.vue
|
||||
**.jsx
|
||||
- name: Run ESLint
|
||||
run: npx eslint ${{steps.get_changed_files.outputs.all_changed_files}}
|
||||
- name: Run Build
|
||||
run: pnpm run build:plugin && pnpm run build:alpha
|
||||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
@ -81,4 +76,4 @@ $ npm run dev
|
|||
如果你对我们的开源项目感兴趣，欢迎通过以下方式加入我们的开源社区。
|
||||
|
||||
- 添加官方小助手微信：opentiny-official，加入我们的技术交流群
|
||||
- 加入邮件列表：opentiny@googlegroups.com
|
||||
- 加入邮件列表：opentiny@googlegroups.com
|
||||
|
|
@ -1,84 +0,0 @@
|
|||
<p align="center">
|
||||
<a href="https://opentiny.design/tiny-engine" target="_blank" rel="noopener noreferrer">
|
||||
<img alt="OpenTiny Logo" src="logo.svg" height="100" style="max-width:100%;">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
<p align="center">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.</p>
|
||||
|
||||
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)
|
||||
Loading…
Reference in New Issue