A library for generating a web form from a Concerto Modelling Language model
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 13 commits ahead of uchibeke:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
packages
.editorconfig
.eslintignore
.eslintrc.yml
.gitattributes
.gitignore
.npmignore
.npmrc
.travis.yml
LICENSE.txt
README.md
lerna.json
package.json

README.md

Concerto Form Generator

This library generates web-form generator for models written in the Concerto Modelling Language.

The Concerto Modelling Language is used by both Hyperledger Composer and Accord Project Cicero as an object-oriented data description (schema) language, based on a textual domain-specific language. Both communities would benefit from improved tooling for the modelling language, including the ability to generate UML style diagrams and web-forms from class descriptions described using the Hyperledger Composer modelling language.

Web Form Generator

A web-form generated from model types would allow transactions to be submitted (or assets/participants created) by filling out a web-form, as opposed to submitting JSON formatted text, easing ease of use and guiding the user. The web form generator dynamically creates form elements based on a root type from a Concerto model. Some simplifying assumptions are made to solve the issue of data-binding from arbitrarily complex object models to web forms. The generated web form generator is an embeddable, modular, component that can be easily embedded in web-based tools, such as Hyperledger Composer Playground, or similar.

How this project is structured

Packages:

  • concerto-form-core, includes the base visitor class and utility functions
  • concerto-form-react, extends the base visitor to provide a ReactJS form
  • concerto-form-demo, uses the react visitor and applies SemanticUI styling

More Information

Concerto Modeling Language | https://github.com/hyperledger/composer-concerto

What does this do

  • Web-form Generator: A functional dynamic web component, that generates a web-form based on the fully-qualified name of a type from a Concerto Model. A sample web application that shows the dynamic web component in action.

  • Ask a question on Stack Overflow

  • Chat on the Rocket.Chat discussion channels

Getting started

If not already installed, install lerna

npm i -g lerna

Install all of the project's dependencies

lerna bootstrap

Run the demo app and experiment with the form generator

cd packages/concerto-form-react/
npm run build
cd ../..

cd packages/concerto-form-demo
npm run start

License

Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/.