Version 2 Blueprint - Githubissues

accordproject / template-studio-v2

Web UI for creating, editing and testing Accord Project templates

Apache License 2.0

15 stars 28 forks source link

Version 2 Blueprint #2

Open jeromesimeon opened 5 years ago

jeromesimeon commented 5 years ago

(From @dselman https://github.com/accordproject/template-studio/issues/99 )

We modularize Template Studio into a set of discrete React components, which interact via Redux.

Ergo (Logic) Editor (https://github.com/accordproject/cicero-ui/issues/7)

Based on https://github.com/react-monaco-editor/react-monaco-editor
We should refactor the VSCode plugin to share the same Language Server and use it with the Monaco editor. https://github.com/TypeFox/monaco-languageclient
https://langserver.org
Existing LSP: https://github.com/accordproject/ergo-vscode-plugin/blob/master/server/src/server.ts

Concerto (Model) Text Editor (https://github.com/accordproject/concerto-ui/issues/1)

Build a new LSP implementation for Concerto, based on https://github.com/hyperledger/composer-vscode-plugin/blob/master/server/src/server.ts
Use Monaco to edit CTO files

Concerto (Model) Graphical Editor (https://github.com/accordproject/concerto-ui/issues/2)

Viewer/editor for Concerto models as interactive UML style diagram, using https://github.com/projectstorm/react-diagrams

Concerto (Model) Form-based Editor (https://github.com/accordproject/concerto-ui/issues/3)

Viewer/editor for Concerto models as a set of class declarations, with properties specified using actions and forms (Add Concept, Add Transaction etc).

Template Library Component (https://github.com/accordproject/cicero-ui/issues/6)

https://github.com/accordproject/react-components
Configurable component to view the contents of an AP format template library

Clause Plugin (https://github.com/accordproject/cicero-ui/issues/5)

A plugin for the contract editor that knows how to both Edit and Design AP Clauses https://github.com/accordproject/contract-editor/blob/master/src/plugins/clausePlugin.js
In Edit mode only variable values can be supplied
In Design mode the grammar text can be edited, variables inserted and their types specified

Contract Editor (extends markdown-editor) (https://github.com/accordproject/cicero-ui/issues/1)

https://github.com/accordproject/contract-editor
In Edit mode can supply values for variables and edit the text of the contract
In Design mode new variables can be inserted and can drag-drop Clauses into the contract

Concerto Form Component (https://github.com/accordproject/concerto-ui/issues/4)

Generate a web form to edit an instance of a Concerto model
https://www.npmjs.com/package/concerto-form-react
Use to edit request.json to test a contract
Use to visualise response.json and state.json

Package.json Editor (https://github.com/accordproject/cicero-ui/issues/4)

Based on Monaco JSON file support

README.md Editor (https://github.com/accordproject/cicero-ui/issues/3)

Based on markdown-editor

Template Execution & Testing (https://github.com/accordproject/cicero-ui/issues/2)

Provide the ability to execute template logic on a given request, for a given state
Allow to set the current time
Allow to select tests based on template's Cucumber tests
Allow to save a new test into the template

jeromesimeon commented 5 years ago

Error Logger (https://github.com/accordproject/cicero-ui/issues/17)

Shows all the errors (validation errors, compilation errors, parsing errors, testing errors).
Lets a user filter errors