JSON Forms - 更多表单,更少代码
瞬间创建复杂表单
文档
请访问 JSON Forms 官方网站 jsonforms.io 获取文档、示例和 API 参考。
开始使用
- 使用
git clone https://github.com/eclipsesource/jsonforms-react-seed.git
克隆种子应用 - 使用
npm ci
安装依赖 - 使用
npm run start
运行应用
有关种子应用的更多信息,请参阅种子仓库的相应 README 文件。 关于 JSON Forms 使用的更详细教程,请参阅本教程。
反馈、帮助和支持
如果遇到任何问题,请随时在仓库中提出问题。 对于问题和讨论,请使用 JSON Forms 论坛。 您也可以通过电子邮件联系我们。 此外,EclipseSource 还为 JSON Forms 提供专业支持。
迁移
更新 JSON Forms 时,请参阅我们的迁移指南。
路线图和里程碑
项目路线图可在 ROADMAP.md 中找到。
问题按以下里程碑分类,指示其计划实施时间。 无论分配的里程碑如何,我们始终欢迎并感谢贡献。
- 下一个次要版本的里程碑。计划在下一个版本中实施的问题。
- 下一个主要版本的里程碑。计划在下一个主要版本中实施的问题。
.x
里程碑。适合在未来几个版本中实施的具体候选问题。- next:我们希望在即将发布的版本中尽快解决的问题。但尚未计划用于特定版本。
- Backlog:某种程度上有趣但在可预见的将来我们不打算自己解决的问题。这些问题仍可能通过社区贡献或付费客户的优先处理成为 JSON Forms 的一部分。
开发者文档
首次设置
- 安装 node.js(目前仅支持 Node v18.19+ < 19)
- 安装 pnpm:https://pnpm.io/installation(使用 pnpm 8.6.2+)
- 克隆此仓库
- 安装依赖:
pnpm i --frozen-lockfile
VS Code 开发容器
作为首次设置的替代方案,您可以使用 devcontainer.json 中配置的 VS Code 开发容器。
- 执行命令:
Remote Containers: Reopen in container
- 等待容器构建和加载完成
- 容器中已执行首次设置和所有包的初始构建
**注意:**如果在打开远程容器之前已安装依赖,其初始化可能会失败。
在这种情况下,您可以尝试使用 git clean -dfx
清理仓库。请注意,这会删除所有未跟踪的文件!
构建和测试
- 构建(所有包):
pnpm run build
- 测试(所有包):
pnpm run test
- 清理(删除所有包的
dist
文件夹):pnpm run clean
- 运行 React Vanilla 示例:
cd packages/vanilla-renderers && pnpm run dev
- 运行 React Material 示例:
cd packages/material-renderers && pnpm run dev
- 运行 Angular Material 示例:
cd packages/angular-material && pnpm run dev
- 运行 Vue Vanilla 开发设置:
cd packages/vue-vanilla && pnpm run serve
依赖和发布管理
有关 JSON Forms 项目如何处理依赖和发布的更多信息,请参阅我们的开发者文档 wiki 页面。
持续集成
JSON Forms 项目通过 Github actions 在 Linux、Mac 和 Windows 上构建和测试。覆盖率由 Coveralls 记录。
贡献
我们欢迎社区参与!无论您是报告错误、提出功能建议、参与讨论还是直接贡献代码,您的参与都非常宝贵。 请参阅此处的贡献指南。
许可证
JSON Forms 项目采用 MIT 许可证。有关更多信息,请参阅 LICENSE 文件。