Skip to content
A library of React components relying on Accord Project Cicero
JavaScript Shell CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github docs(issues): remove extra issue template Jun 19, 2019
.travis (fix) travis key variables May 4, 2019
__mocks__ test(ErrorLogger): add snapshot and configure jest mock May 9, 2019
assets refactor(src): reposition icons for babel compile - I89 Aug 1, 2019
demo/src fix(VariablePlugin): fix check for inside a variable and update demo … Nov 18, 2019
scripts (chore) Initial publish scripts for npm deployment May 4, 2019
src
.babelrc
.eslintignore
.eslintrc chore(eslint): configure eslint to ignore console error commands - I6 Apr 22, 2019
.gitignore chore(gitignore): add thumbs.db (#173) Oct 19, 2019
.travis.yml (fix) Move transpile to prepublishOnly in build/testing May 15, 2019
CHARTER.md docs(CHARTER): implement linux foundation charter - I65 Jul 12, 2019
CONTRIBUTING.md
DEVELOPERS.md
LICENSE
README.md
markdown-license.txt docs(*): add markdown license file - I37 May 8, 2019
package-lock.json
package.json
webpack.config.js refactor(webpack): split webpack config by dev and prod Oct 1, 2019
webpack.config.prod.js refactor(webpack): split webpack config by dev and prod Oct 1, 2019

README.md

Cicero UI Library

Build Status downloads npm version join slack

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

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:

Available Plugins:

Components still in development:

Development

  1. Fork project to your repository
  2. Clone to the local machine with git clone
  3. cd into the directory
  4. Run npm install
  5. 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
  6. Build a production state with npm run build
  7. Transpile code for build with npm run transpile
  8. Create a global link with npm link
  9. 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:


Accord Project Logo

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

UI Components:

Projects Package name Version Description
Markdown Editor markdown-editor npm version WYSIWYG rich text web editor that persists text as markdown. Based on Slate.js
Cicero UI cicero-ui npm version WYSIWYG contract editor, template libary browser, error panel component
Concerto UI concerto-ui npm version 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.

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

Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respective owners. See LF Projects Trademark Policy.

You can’t perform that action at this time.