|
1 |
| -# json-schema-form |
2 |
| -Core library |
| 1 | +# JSON Schema Form Core |
| 2 | +[](https://gitter.im/json-schema-form/angular-schema-form?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| 3 | +[](https://travis-ci.org/json-schema-form/json-schema-form-core) |
| 4 | + |
| 5 | +Core library for working with JSON-Schema with a UI-Schema (Form) definition that doesn't depend on a framework. |
| 6 | + |
| 7 | +This library, through the use of its merge module, combines the schema and ui-schema |
| 8 | +into a canonical schema for use by its services and external libraries. |
| 9 | + |
| 10 | +You **DO NOT** use this file in addition to Angular Schema Form, it is embedded at |
| 11 | +build into any frameworks using it. |
| 12 | + |
| 13 | +## Work-In-Progress! |
| 14 | +There is [test output](docs/test.md) that forms some super basic documentation |
| 15 | +and I intend to expand them much further to the point of almost being |
| 16 | +useful before I create a proper API and document that. |
| 17 | + |
| 18 | +## Keeping Track |
| 19 | +After changing to Webpack 2, this library now includes a detailed version |
| 20 | +header which is passed through into `Angular Schema Form` and also the `Bootstrap` decorator bundle |
| 21 | + |
| 22 | +```javascript |
| 23 | +/*! |
| 24 | + * json-schema-form-core |
| 25 | + * @version 1.0.0-alpha.5 |
| 26 | + * @date Sat, 14 Jan 2017 08:08:15 GMT |
| 27 | + * @link https://github.com/json-schema-form/json-schema-form-core |
| 28 | + * @license MIT |
| 29 | + * Copyright (c) 2014-2017 JSON Schema Form |
| 30 | + */ |
| 31 | +``` |
| 32 | + |
| 33 | +## Contributing / Plans |
| 34 | +The main contributions we need to the core at the moment are related to both the migration |
| 35 | +of `Angular Schema Form` features to the core (like templates/builders) and the addition |
| 36 | +of an API for use by ASF (Angular) and RSF (React) libraries. |
| 37 | + |
| 38 | +Please contact @Anthropic via our [Gitter](https://gitter.im/json-schema-form/angular-schema-form) if you wish to get involved. |
| 39 | + |
| 40 | +## Testing it |
| 41 | + |
| 42 | +### With Angular Schema Form |
| 43 | +There is a branch in angular-schema-form called `feature/webpack-babel` that integrates the core. |
| 44 | +To use it roughly follow these steps: |
| 45 | + |
| 46 | +* Clone angular-schema-form to a **sibling** directory and switch to branch `feature/webpack-babel` |
| 47 | +* `npm install` to install dependencies |
| 48 | +* `npm run build` to build with the core. |
| 49 | +* Use dist/angular-schema-form.js, now with the core from this folder. *No need to also load ObjectPath since it is already included* |
| 50 | + |
| 51 | +### With Mocha tests |
| 52 | +Tests are written in mocha + chai and run trough `npm test`. |
| 53 | + |
| 54 | +When the command `npm run testdoc` is run instead, the tests will also generate a readable |
| 55 | +`markdown` file [test.md](docs/test.md) to document elements of the library. |
| 56 | + |
| 57 | +## Notes |
| 58 | +* ObjectPath is bundled with json-schema-form-core |
| 59 | +* angular-schema-form bundles json-schema-form-core so the user doesn't have to include it as an dependency. |
| 60 | +* The code for not using ObjectPath on Angular 1.2 is removed. Could maybe be fixed but I (davidlgj) strongly believe its time to drop Angular 1.2 support since it complicates validation code as well. |
0 commit comments