0.0.25 • Published 6 years ago

hyperledger-composer-form v0.0.25

Weekly downloads
4
License
Apache-2.0
Repository
github
Last release
6 years ago

Hyperledger Composer Form

Hyperledger Composer Form is a form generator for Hyperledger composer.

Coverage Status

Build Status

The Hyperledger Composer 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 Hyperledger Composer 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

  • Three packages: main, react-app and vanilla-js

  • The main package does the work and react-app and vanilla-js use the form generated by main

  • Each package has it's own package.json

More Information

Modeling Language | Hyperledger Composer: https://hyperledger.github.io/composer/reference/cto_language.html GitHub - accordproject/cicero: Open Source implementation of Accord Protocol Template Specification: https://github.com/accordproject/cicero Hyperledger Composer: https://composer-playground.mybluemix.net

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 Hyperledger Composer 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

Suggested reading list is:

Getting in touch

If you have a question on using Hyperledger Composer

If you have found a defect or want to raise a feature requests

If you want to contribute to the develop of Hyperledger Composer

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/.