Skip to content

hyperledger-iroha/iroha-2-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

4de14b2 · Jun 8, 2022
May 17, 2022
May 24, 2022
Jun 8, 2022
Feb 2, 2022
Apr 29, 2022
May 18, 2022
Mar 2, 2022
May 27, 2022
May 17, 2022
May 17, 2022
Feb 3, 2022

Repository files navigation

Hyperledger Iroha 2 Tutorial

This repository contains the source files for Hyperledger Iroha 2 Tutorial.

The tutorial is suitable for both experienced and novice users. It explains Iroha 2 concepts and features, and also offers language-specific step-by-step guides for these programming languages:

If you are already familiar with Hyperledger Iroha, we invite you to read about how Iroha 2 is different from its previous version.

Check the Hyperledger Iroha 2 repository for more detailed information about API and available features.

Contribution

If you want to contribute to Iroha 2 tutorial, please clone the repository and follow the steps below.

Prepare the environment

  1. Install Node.js v16. To install it without a headache, use NVM (Node Version Manager). You can run something like this:

    # Install NVM itself
    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
    
    # Run it to use NVM in the current shell session or restart your shell
    export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
    [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm

    Then you can install Node 16:

    nvm install 16
  2. Install PNPM, a package manager used by this project. If you've installed Node.js, you can install PNPM with this command:

    npm i -g pnpm
  3. Install the packages for this project. From the root of the cloned repository, run:

    pnpm i

Run dev mode

pnpm dev

It will start a local dev-server. You will be able to open a browser, observe rendered documentation, edit source files and see your edits on-demand.

Format documentation

We use Prettier to format Markdown files. Its configuration is located at ./.prettierrc.js. Check options reference for all available options.

  • Format doc files: apply Prettier formatting to all Markdown files

    pnpm format:docs:fix
  • Check the formatting in doc files: ensure that all documentation files match Prettier code style

    pnpm format:docs:check

License

Iroha documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/