❗---❗---❗---❗DEPRECATED❗---❗---❗---❗

This repository has been moved to https://github.com/accordproject/web-components

Cicero UI Library

The Accord Project Cicero UI Library can be used for implementing React components in your contract editing studio.

Demo

Instructions

This is a short reference guide, for a more full context, please refer to our CONTRIBUTING guide and information for DEVELOPERS.

For using individual components in an app, refer to the individual component's README.

Implementation

Components ready for use:

Components still in development:

ParseResult
TemplateLoadingClauseEditor

Development

Fork project to your repository
Clone to the local machine with git clone
cd into the directory
Run npm install
Ensure the IBM Plex Sans is imported with <link href="https://fonts.googleapis.com/css?family=IBM+Plex+Sans:300,400,500,500i,700" rel="stylesheet"> is in the *.html file of your main app
Build a production state with npm run build
Transpile code for build with npm run transpile
Create a global link with npm link
In your main app directory, run npm link @accordproject/cicero-ui

Available Scripts

In the project directory, you can run:

`npm run start`

Runs the app in the development mode.
Open http://localhost:8080 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console. NOTE: These require templates to be passed down through props from an app in which these components should be rendered.

`npm run test`

Launches JEST over the repository. Current snapshot tests require npm test -- -u to update when all changes are final.

`npm run lint`

Runs ESLint.

`npm run build`

Builds the app for production to the demo folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

Structure of the Code Repository

Top level repository (cicero-ui), with sub packages. The entire package is published as an independent npm module:

ContractEditor: Functional ReactJS component for a rich text contract editor which wraps the @accordproject/markdown-editor editor and extends with clause support.
ErrorLogger: Functional ReactJS component for displaying model and logic errors associated with contracts and clauses with location information when applicable.
Navigation: Functional ReactJS component for displaying markdown headings and clause nodes associated with contracts.
ParseResult:
Library: Provides a ReactJS component to fetch and display a collection of library items.
TemplateLoadingClauseEditor:

Accord Project is an open source, non-profit, initiative working to transform contract management and contract automation by digitizing contracts. Accord Project operates under the umbrella of the Linux Foundation. The technical charter for the Accord Project can be found here.

Learn More About Accord Project

Overview

Documentation

Ecosystem

Core libraries:

Projects	Package name	Description
Cicero	cicero-core	Templates Core
	cicero-cli	Cicero CLI
	cicero-engine	Node.js VM based implementation of Accord Project Template Specification execution
	cicero-server	Wraps the Cicero Engine and exposes it as a RESTful service
	cicero-test	Testing support for Cicero based on cucumber
	cicero-tools	Cicero Tools
	generator-cicero-template	Code generator for a Cicero Template
Concerto	concerto-core	Core Implementation for the Concerto Modeling Language
	concerto-tools	Tools for the Concerto Modeling Language
	concerto-cli	command-line interface for Concerto
Ergo	ergo-cli	Ergo CLI
	ergo-compiler	Ergo compiler
	ergo-test	Ergo test
	ergo-engine	Ergo engine
Markdown	markdown-common	A framework for transforming markdown
	markdown-slate	Transform markdown to/from CommonMark DOM
	markdown-cli	CLI for markdown transformations.
	markdown-cicero	CiceroDOM: Markdown extensions for contracts, clauses, variables etc.
	markdown-html	Transform CiceroDOM to HTML

UI Components:

Projects	Package name	Description
Markdown Editor	markdown-editor	WYSIWYG rich text web editor that persists text as markdown. Based on Slate.js
Cicero UI	cicero-ui	WYSIWYG contract editor, library browser, error panel component
Concerto UI	concerto-ui	Dynamic web forms generated from Concerto models

Template Editors:

Projects	Cicero ver.	Description
Template Studio v1	0.13.4	Web UI for creating, editing and testing Accord Project templates
Template Studio v2	0.13.4	Web UI for creating, editing and testing Accord Project templates
VSCode Extension	0.13.4	VS Code extension for editing Cicero templates and Ergo logic

Public templates and models:

Projects	Description
Models	Accord Project Model Library
Template Library	Accord Project Template Library

Documentation:

Project	Repo
Documentation	techdocs

Contributing

The Accord Project technology is being developed as open source. All the software packages are being actively maintained on GitHub and we encourage organizations and individuals to contribute requirements, documentation, issues, new templates, and code.

Find out what’s coming on our blog.

Join the Accord Project Technology Working Group Slack channel to get involved!

For code contributions, read our CONTRIBUTING guide and information for DEVELOPERS.

README Badge

Using Accord Project? Add a README badge to let everyone know:

[![accord project](https://img.shields.io/badge/powered%20by-accord%20project-19C6C8.svg)](https://www.accordproject.org/)

License

Accord Project source code files are made available under the Apache License, Version 2.0. Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0).

accordproject / cicero-ui

readme