Skip to content

Latest commit

 

History

History
166 lines (119 loc) · 7.55 KB

README.md

File metadata and controls

166 lines (119 loc) · 7.55 KB
Raw

Cicero UI Library

Build Status downloads npm version

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:

  • ClausePlugin
  • VariableePlugin

Components still in development:

Development

  1. Fork project to your repository
  2. Clone to 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 requires npm test -- -u in order 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:

  • ClauseEditor: Functional ReactJS component which displays text of Clause in @accordproject/markdown-editor and parses text using associated template.
  • ContractEditor: Functional ReactJS component for a rich text contract editor which wraps the @accordproject/markdown-editor editor and assings the Clause plugin.
  • 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:
  • TemplateLibrary: Provides a ReactJS component to fetch and display a library of contract and clause templates in the Accord Project Cicero format.
  • TemplateLoadingClauseEditor:
  • ClausePlugin: A custom Slate plugin for embedding a clause node within a document
  • VariablePlugin: A custom Slate plugin for using editable, highlighted variables within a clause
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

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.