Skip to content
Accord Project Documentation
CSS JavaScript Shell HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
assets
docs
scripts
website
.all-contributorsrc
.gitignore
CHARTER.md
CONTRIBUTING.md
DEVELOPERS.md
LICENSE
README.md

README.md

Accord Project Logo

Contributors GitHub license Join the Accord Project Slack

Introduction

Technical Documentation for all Accord Project code. This site uses Docusaurus to generate static HTML.

The site is hosted at: https://docs.accordproject.org

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.

Installation

To build the documentation locally:

cd ./website
npm run start

If you want to re-generate the JSDoc API:

npm run build:api

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 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 for markdown based on Slate.js
Cicero UI cicero-ui npm version React UI components for Cicero
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.

Contributors

Thanks goes to these wonderful people (emoji key):

4dd3r
4dd3r

💻
4katie
4katie

💻
It's Lex
It's Lex

💻
DEBSUBHRA ROY
DEBSUBHRA ROY

💻
Felix Kühl
Felix Kühl

💻
Nico Britz
Nico Britz

💻
Yash Garg
Yash Garg

💻
ContractPen
ContractPen

💻
Dmitriy Danilov
Dmitriy Danilov

💻
Dan Selman
Dan Selman

💻
Jolene Langlinais
Jolene Langlinais

💻
Javier Canossini
Javier Canossini

💻
Joseph J Bambara
Joseph J Bambara

💻
Jerome Simeon
Jerome Simeon

💻
Alexey Pyltsyn
Alexey Pyltsyn

💻
Matt Roberts
Matt Roberts

💻
Nithilan Kalidoss
Nithilan Kalidoss

💻
Oorjit Chowdhary
Oorjit Chowdhary

💻
Peter Hunn
Peter Hunn

💻
Pranjal Vyas
Pranjal Vyas

💻
Ryan (Chiungting) Lin
Ryan (Chiungting) Lin

💻
Sanket Shah
Sanket Shah

💻
Steffin Stanly
Steffin Stanly

💻
Sumit Kharche
Sumit Kharche

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

You can’t perform that action at this time.