README
Concerto
Introduction
Concerto is a lightweight 100% JavaScript schema language and runtime. It works in both a Node.js process and in your browser. The browserified version of Concerto is ±280KB. We are working on making it even smaller.
This is why you should care: https://www.accordproject.org/news/strongly-typed-data-for-javascript-and-beyond/
Things you can do using Concerto:
- Define an object-oriented model using a domain-specific language that is much easier to read and write than JSON/XML Schema, XMI or equivalents. The metamodel gives you "just enough" expressivity to capture real-world business models, while remaining easy to map to most runtime environments.
- Optionally edit your models using a powerful VS Code add-on with syntax highlighting and validation
- Create runtime instances of your model
- Serialize your instances to JSON
- Deserialize (and optionally validate) instances from JSON
- Instances are JS objects so they are easy to pass around your application
- Introspect the model using a powerful set of APIs
- Convert the model to other formats: JSON Schema, XML Schema, Java, Go, Typescript, Loopback, PlantUML using concerto-tools.
- Import models from URLs
- Publish your reusable models to any website, including the Accord Project Open Source model repository, hosted at: https://models.accordproject.org
Structure of the Code Repository
Top level repository (concerto), with sub packages. Each sub-package is published as an independent npm module using lerna:
- concerto-cli : command-line interface for Concerto
- concerto-core : core library for model management/parsing/validation/serialization
- concerto-tools : model converters and tools for Concerto model files
Installation
To install the command-line interface:
npm install -g @accordproject/concerto-cli
You may also set a custom folder to keep the log files by setting the following environment variable:
export CONCERTO_LOG_FOLDER_PATH="/tmp"
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
- Accord Project
- Accord Project News
- Accord Project Blog
- Accord Project Slack
- Accord Project Technical Documentation
- Accord Project GitHub
Documentation
- Getting Started with Accord Project
- Concepts and High-level Architecture
- How to use the Cicero Templating System
- How to Author Accord Project Templates
- Ergo Language Guide
Ecosystem
Core libraries:
| Projects | Package name | Version | 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 | Version | 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.
README Badge
Using Accord Project? Add a README badge to let everyone know: 
[](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).
Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respective owners. See LF Projects Trademark Policy.