131 lines
3.6 KiB
Markdown
131 lines
3.6 KiB
Markdown
<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-code platforms online in real time, and support secondary development or integration of low-code platform capabilities.</p>
|
||
|
||
[](https://deepwiki.com/opentiny/tiny-engine)
|
||
|
||
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 LLM capabilities to help developers build applications.
|
||
|
||
## Documentation
|
||
|
||
- intro：https://opentiny.design/tiny-engine#/home
|
||
- tutorial：https://opentiny.design/tiny-engine#/help-center/index
|
||
- playground：https://opentiny.design/tiny-engine#/tiny-engine-editor
|
||
|
||
## Usage
|
||
|
||
### Environment Setup
|
||
|
||
- Install Node.js 18+
|
||
|
||
- Install pnpm 9+
|
||
|
||
```sh
|
||
$ npm install -g pnpm
|
||
```
|
||
|
||
### Create Low-Code Platform using CLI
|
||
|
||
```sh
|
||
# Create low-code platform
|
||
$ npx @opentiny/tiny-engine-cli@latest create-platform <name>
|
||
# Enter the low-code platform directory
|
||
$ cd <name>
|
||
# Install dependencies
|
||
$ pnpm install
|
||
```
|
||
|
||
### Local development: Start the local mock server and use the mock data of the local mock server.
|
||
|
||
> The mock server included with the created low-code platform only provides basic backend mock functionality. If you need to experience the complete backend service capabilities, please refer to the Java backend startup instructions below.
|
||
|
||
```sh
|
||
$ pnpm dev
|
||
```
|
||
|
||
### Local Development with Java Backend
|
||
|
||
Java backend repository: https://github.com/opentiny/tiny-engine-backend-java
|
||
|
||
Start Java backend for frontend-backend integration:
|
||
|
||
[Frontend-Backend Integration Documentation](https://docs.opentiny.design/tiny-engine/dev/debugging-of-java-backend)
|
||
|
||
### Materials Synchronization [Solution](https://docs.opentiny.design/tiny-engine/dev/material-sync-solution)
|
||
|
||
```sh
|
||
$ pnpm splitMaterials
|
||
```
|
||
|
||
```sh
|
||
$ pnpm buildMaterials
|
||
```
|
||
|
||
Open a browser: `http://localhost:8080/?type=app&id=1&tenant=1&pageid=1`
|
||
`url search` Parameters:
|
||
|
||
- `type=app` Application type
|
||
- `id=xxx` Application ID
|
||
- `tenant=xxx` Organization ID
|
||
- `pageid=xxx` Page ID
|
||
|
||
## Build
|
||
|
||
```sh
|
||
# Build Designer
|
||
pnpm run build:alpha or build:prod
|
||
```
|
||
|
||
## Milestones
|
||
|
||
```mermaid
|
||
gantt
|
||
dateFormat YYYY-MM-DD
|
||
axisFormat %Y-%m-%d
|
||
|
||
1.0.0-beta.x version : 2023-09-25, 2024-05-20
|
||
1.0.0-rc version(refactor version) : 2024-10-01
|
||
1.0.0 version : 2024-11-01
|
||
2.0.0 version : 2024-12-16
|
||
2.1.0 version : 2025-01-02
|
||
2.2.0 version : 2025-02-19
|
||
2.3.0 version : 2025-03-14
|
||
2.4.0 version : 2025-04-07
|
||
2.5.0 version : 2025-05-15
|
||
```
|
||
|
||
## 🤝 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
|
||
|
||
## ❤️ Acknowledgments
|
||
|
||
Thanks to all the developers who have contributed to TinyEngine!
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/opentiny/tiny-engine/graphs/contributors" target="_blank">
|
||
<img alt="Contributors" src="https://contrib.rocks/image?repo=opentiny/tiny-engine">
|
||
</a>
|
||
</p>
|
||
|
||
## License
|
||
|
||
[MIT](LICENSE) |