JSON Forms - More Forms. Less Code
Complex forms in the blink of an eye
Please see the official JSON Forms website, jsonforms.io, for documentation, examples and API references.
- Clone the seed app with
git clone https://github.com/eclipsesource/jsonforms-react-seed.git
- Install dependencies with
npm installwhen using an older version)
- Run the app with
npm run start
Upgrading to JSON Forms 3.0 Alpha
With version 3.0 of JSON Forms we removed
json-schema-ref-parser from the core package. This change only affects users of the React variant (Vue and Angular are not affected) and even for React only a few users will need to adjust their code. To avoid issues and for more information, please have a look at our migration guide.
Feedback, Help and Support
If you encounter any problems feel free to open an issue on the repo. For questions and discussions please use the JSON Forms board. You can also reach us via email. In addition, EclipseSource also offers professional support for JSON Forms.
First time setup
- Install node.js (only Node 14 and npm 6 is currently supported)
- Clone this repository
- Install dependencies:
- Hook up dependencies between packages:
npm run init
Build & Testing
- Build (all packages):
npm run build
- Test (all packages):
npm run test
- Clean (delete
distfolder of all packages):
npm run clean
- Run React Vanilla examples:
cd packages/vanilla && npm run dev
- Run React Material examples:
cd packages/material && npm run dev
- Run Angular Material examples:
cd packages/angular-material && npm run dev
- Run Vue Vanilla dev setup:
cd packages/vue/vue-vanilla && npm run serve
Dependency & Release management
For more info about how we handle dependencies and releases in the JSON Forms project, please see our Developer Documentation wiki page.
The JSON Forms project is built and tested via Github actions on Linux, Mac and Windows. Coverage is documented by Coveralls.
The JSON Forms project is licensed under the MIT License. See the LICENSE file for more information.
See our migration guide when updating JSON Forms.