Skip to content

Latest commit

 

History

History
114 lines (67 loc) · 6.41 KB

getting-started.md

File metadata and controls

114 lines (67 loc) · 6.41 KB
Raw

Contributing to Composer

Getting Started Developing Hyperledger Composer

This guide will help you start to contribute to the Hyperledger Composer project. It will show you how to set up your local environment and walk through the development, code, test and deploy process. You will do this by creating a small change of your own.

Please note that this is the Getting Started for developing Hyperledger Composer itself, and not a guide to developing applications using Hyperledger Composer. (Though a lot of the tool chain will be useful for that purpose as well).

After reading this guide, move on to reading the coding-guidelines that will explain in more detail the process to follow to make changes.

Setup Scripts

The requirements for developing Hyperledger Composer are the same as developing an application using Hyperledger Composer. Follow these instructions

If you wish to install manually or review the individual tool's own documentation the details are below.

Tool Chain Reference Details

This is a summary of the tools that will be required to work on Hyperledger Composer. Other tools are required but these will be installed automatically.

  • Git This is probably already installed on most Linux machines. Setup is well documented on the ibm.git website . Pay particular attention to setting up the SSL keys that are required.

  • Docker Essential for the running of the tests and for running the HyperLedger Fabric.

    • Ubuntu: Firstly the Docker Engine needs to be installed, then the docker-compose tool is required with these instructions. Some initial notes on administering docker are here

  • **Node.js v8.9 or higher (but not node v9) ** The main runtime of Hyperledger Composer and also has the NPM tool that is used for a lot of the package management.

  • Chrome Web test suites use karma to launch a browser, and consequently Chrome must be installed to prevent test failures without editing the karma configuration to use a supported browser that you already have installed.

Forking and Cloning the Hyperledger Composer Repository

Once those tools are installed you are ready to get going with the Hyperledger Composer repository. Let's show you how to create your own version of the Hyperledger Composer repository on GitHub, and clone it to your local machine to allow you to make your own changes, which you can subsequently contribute to the Hyperledger Composer project.

  • Navigate to the Hyperledger Project on GitHub to see the different Hyperledger Composer repositories.
  • Select the Hyperledger Composer repository
  • Click on the Fork button to fork this repository to your user space.
  • Navigate to your home page on GitHub, you'll be able to see your fork of the repository.

Choosing a Location For Your Clone

If this is your first Git project then you might like to spend a few moments creating a specific directory for all your local git repositories, e.g. ~/github/ on unix file systems, which will put the project under your home directory, which is good default location. Windows note: this will all be done in the git bash shell that was installed for you.

$ mkdir -p ~/github
$ cd ~/github

IMPORTANT Do NOT have any directory in the path to the git repository directory you just created, start with a _ (underscore). This is due to the way that the JavaScript documentation tool handles filtering path names. If you do this, then the tool reports there are no source files to produce documentation for.

The final step is to issue the clone command. This format is assuming that you have setup the ssh keys for GitHub.

$ git clone [email protected]:<your-username>/hyperledger/composer.git
$ cd composer

Installing Hyperledger Composer Prerequisites

Hyperledger Composer has a number of prerequisites - for its runtime, code hygiene, tests, API documentation, and more. Before you can develop locally, you need to install these using npm. These prerequisites are installed as development dependencies. The packages are installed locally rather than globally so that their versions do not interfere with other projects you may be developing or global installations of these packages on your local machine. You can also install these prerequisites globally, though it is required to have some packages locally, e.g. the test framework.

Installing the npm Dependencies

You must bootstrap the repository so that all of the dependencies are installed and all of the packages are linked together:

$ npm run bootstrap

You can then work with the packages under packages/ on a per-package basis as any normal node.js package.

For example, inorder to run Playground UI locally you can run:

$ npm start

on composer-playground-api and composer-playground packages in turn followed by visiting:

localhost:3000

from your browser.

Alternatively, you can execute npm commands across all of the packages at once using Lerna:

$ npm test

To clean the updates

$ npm run repoclean

Your development environment is ready!

You are now ready to try out your local clone of the Hyperledger Composer project.

Testing your local environment

To verify that your local environment is ready for development and to confirm later that the updates are good, run the built-in unit tests provided with the Hyperledger Composer project.

$ npm test

This will run the unit tests that are associated with all the modules.

Next step

Moving on to read