Skip to content

Latest commit

 

History

History
61 lines (53 loc) · 1.6 KB

README.md

File metadata and controls

61 lines (53 loc) · 1.6 KB

accord project

Accord Internship Contract

This is a sample accord template for internship contracts.

Setup

  • Clone this repository
  • cd into the directory
cd accord-internship-contract/
  • run the following command
npm install

Usage

  • There is sample contract data present in sample.md.
  • Run the following command and the output will be a JSON object containing age value.
npx cicero trigger
  • To extract the data from contract text.
npx cicero parse --output data.json
  • To update the contract text data there are two ways
    • Change the data directly in text/sample.md OR
    • Update data.json then draft the contract text using
    npx cicero draft --output text/sample.md

Documentation

  • The report on this project is generated using AsciiDoctor
  • Install AsciiDoctor
  • For Debian and Ubuntu
sudo apt-get install asciidoctor
gem install asciidoctor-diagram
  • Generate html document
asciidoctor -r asciidoctor-diagram Report.adoc
  • This will generate a Report.html file which can be opened using a browser.
  • If you face an issues saying
    java.io.IOException: Cannot run program "/opt/local/bin/dot": error=2, No such file or directory
    Then Install Graphviz
sudo apt install graphviz