Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 3.74 KB

README.md

File metadata and controls

75 lines (48 loc) · 3.74 KB
Raw

JSON Forms - More Forms. Less Code

Complex forms in the blink of an eye

Documentation

Please see the official JSON Forms website, jsonforms.io, for documentation, examples and API references.

Getting started

  1. Clone the seed app with git clone https://github.com/eclipsesource/jsonforms-react-seed.git
  2. Install dependencies with npm ci
  3. Run the app with npm run start

For more info about the seed app, please see the corresponding README file of the seed repo. For a more detailed tutorial about the usage of JSON Forms, please see this tutorial.

Upgrading to JSON Forms 3.0

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.

Developers Documentation

First time setup

  • Install node.js (Node >= 14 and npm >= 6 is currently supported)
  • Install pnpm (>= 6.0.0)
  • Clone this repository
  • Install dependencies and Hook up dependencies between packages: pnpm install

VS Code dev container

As an alternative to the first time setup, you can use the provided VS Code dev container configured in devcontainer.json.

  • Execute command: Remote Containers: Reopen in container
  • Wait until the container is built and loaded
  • First time setup and an initial build of all packages has been executed in the container

Build & Testing

  • Build (all packages): pnpm build
  • Test (all packages): pnpm test
  • Clean (delete dist folder of all packages): pnpm clean
  • Run React Vanilla examples: cd packages/vanilla && pnpm dev
  • Run React Material examples: cd packages/material && pnpm dev
  • Run Angular Material examples: cd packages/angular-material && pnpm dev
  • Run Vue Vanilla dev setup: cd packages/vue/vue-vanilla && pnpm 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.

Continuous Integration

The JSON Forms project is built and tested via Github actions on Linux, Mac and Windows. Coverage is documented by Coveralls.

Current status: Build status Coverage Status

License

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

Migration

See our migration guide when updating JSON Forms.