tiny-engine/README.md

65 lines
1.8 KiB
Markdown
Raw Normal View History

<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>
2023-09-20 10:42:50 +08:00
<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.
## Development
### Dependencies required for installation
```sh
2023-09-29 11:17:46 +08:00
$ pnpm install
```
### Local development: Start the local mock server and use the mock data of the local mock server.
```sh
2023-09-29 11:17:46 +08:00
$ 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
2023-09-29 11:17:46 +08:00
- `pageid=xxx` Page ID
## Build
```sh
# Build all plug-ins first
2023-09-29 11:17:46 +08:00
pnpm build:plugin
# Build Designer
2023-09-29 11:17:46 +08:00
pnpm build:alpha or build:prod
```
## 🤝 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)