Giter VIP home page Giter VIP logo

jsonforms's Introduction

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.

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

  • Build: npm run build (runs tslint as well)
  • Test: npm run test

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

Continuous Integration

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

Current status: Build Status Coverage 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.

jsonforms's People

Contributors

edgarmueller avatar sdirix avatar eneufeld avatar planger avatar mahadihasan avatar koegel avatar hecforga avatar muenchdo avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.