JSONForms extends the AngularJS view model approach by eliminating the need to write HTML templates in order to create forms by leveraging the capabilities of JSON and JSON schema.
- Install node.js(version > 4.x.x)
- Install typings:
npm install -g typings - Install tslint:
npm install -g tslint - Install webpack:
npm install -g webpack - Clone this repository
- Install dependencies:
npm install
- Build:
npm run build(runstslintas well) - Test:
npm run test
- Install JSON Forms via
npm install jsonformsand require it viarequire('jsonforms') - Annotate the element, where you want to place a form, with a
jsfclass attribute. - Render a form with the
jsonformselement:
The simplest example looks like this, where schema, uiSchema and data are
properties of a aliased controller named vm:
<div class="jsf">
<jsonforms schema="vm.schema" ui-schema="vm.uiSchema" data="vm.data"/
</div>The JSONForms project is build and tested via Travis. Coverage is documented by Coveralls.
Current status: 
- Locally login as one of the (npm) owners of the package (npm doc)
- Make sure your workspace looks exactly the way you want to release it. (Files specified in .npmignore are normally ignored by npm, but this functionality is buggy. Therefore to be sure you should still remove all unwanted files before deploying.)
- Run either
npm run publish-patch,npm run publish-minorornpm run publish-major.
The script does the following:
- Increase version in package.json
- Commit version bump to the current branch
- Checkout a new temporary deploy-branch
- Commit
dist/jsonforms.jsfile - Create a new version tag
- Push the version tag to 'upstream'
- Release the workspace to npmjs
If any of the steps fail the script will abort. If the script was successful you should create a pull-request with the version bump commit to 'upstream'.
The JSONForms project is licensed under the MIT License. See the LICENSE file for more information.
Our current roadmap is available here.