/cicero-template-library

Accord Project Template Library

Primary LanguageHTMLApache License 2.0Apache-2.0

Accord Project Logo

Accord Project Template Library

Build Status GitHub license Accord Project

Repository for Smart Legal Contract Templates that conform that to the Accord Project Template Specification, the protocol is managed by the open-source community of the Accord Project.

These templates can be parsed and executed by the Cicero engine.

Library

The contents of this repository is automatically tested, built and published to the Accord Project Template Library, hosted at https://templates.accordproject.org.

Contributing

Can't find something? Then why not make a new template yourself?

Follow the instructions in the docs.

Testing

To install and test all the templates locally, clone this repository and use lerna:

npm install -g lerna@^3.15.0
lerna bootstrap
lerna run test

Building Static Pages

To generate the static HTML pages for each template, run:

npm run build

By default, old pages will include links to newer versions of templates, to skip regeneration of old pages with the latest set of links, run:

SKIP_DROPDOWNS=true npm run build

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

README Badge

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

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