The techdocs from forassk

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

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

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

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_4dd3r 💻	_4katie 💻	_{It's Lex} 💻	_{DEBSUBHRA ROY} 💻	_{Felix Kühl} 💻	_{Nico Britz} 💻	_{Yash Garg} 💻
_ContractPen 💻	_{Dmitriy Danilov} 💻	_{Dan Selman} 💻	_{Jolene Langlinais} 💻	_{Javier Canossini} 💻	_{Joseph J Bambara} 💻	_{Jerome Simeon} 💻
_{Alexey Pyltsyn} 💻	_{Matt Roberts} 💻	_{Nithilan Kalidoss} 💻	_{Oorjit Chowdhary} 💻	_{Peter Hunn} 💻	_{Pranjal Vyas} 💻	_{Ryan (Chiungting) Lin} 💻
_{Sanket Shah} 💻	_{Steffin Stanly} 💻	_{Sumit Kharche} 💻