JSONForms - Customizable AngularJS forms based on JSON Schema

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.

1.0 Release!

After more than one and a half years of development with over 500 commits we are proud to announce the v1.0 release of JSONForms on 22nd July of 2016. The release will include among other things a lot of bugfixes, a stable API and the switch to semantic versioning.

Stay tuned for more news regarding the future of JSONForms.

First time setup

• 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 & Testing

• Normal Build: npm run build (runs tslint as well)
• Bootstrap Build: npm run build-bootstrap
• Test: npm run test
• Watch: npm run dev, point your browser to http://localhost:8080/webpack-dev-server/

Usage

1. Install JSON Forms via npm install jsonforms and require it via require('jsonforms')
2. Annotate the element, where you want to place a form, with a jsf class attribute.
3. Render a form with the jsonforms element:

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" uischema="vm.uiSchema" data="vm.data"/
  </div>

Continuous Integration

The JSONForms project is build and tested via Travis. Coverage is documented by Coveralls.

Current status:

Deployment

• 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-minor or npm 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.js file
• 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'.

License

The JSONForms project is licensed under the MIT License. See the LICENSE file for more information.

Roadmap

Our current roadmap is available here.