Customer Loyalty Program with Hyperledger Composer

Following topics are convered with this code:

• Create basic business network using Hyperledger Composer framework
• Deploy the network to an instance of Hyperledger Fabric locally or on IBM Blockchain Starter Plan
• Build a Node.js web application to interact with the blockchain network using Composer API

Note The blockchain network will have multiple members and partners

1. Member is registered on the network
2. Member can sign-in to make transactions to earn points, redeem points and view their transactions
3. Partner is registered on the network
4. Partner can sign-in to view their transactions and display dashboard

Included Components

• Hyperledger Composer v0.19.4 Hyperledger Composer is an extensive, open development toolset and framework to make developing blockchain applications easier
• Hyperledger Fabric v1.1 Hyperledger Fabric is a platform for distributed ledger solutions, underpinned by a modular architecture delivering high degrees of confidentiality, resiliency, flexibility and scalability.
• IBM Blockchain Starter Plan The IBM Blockchain Platform Starter Plan allows to build and try out blockchain network in an environment designed for development and testing

Featured technology

• Nodejs Node.js is an open-source, cross-platform JavaScript run-time environment that executes JavaScript code server-side
• Bootstrap Bootstrap is an open source toolkit for developing with HTML, CSS, and JS

Running the Application

Follow these steps to setup and run this code pattern. The steps are described in detail below.

Prerequisite

• npm (v5.x)
• Node (version 8.9 or higher - note version 9 is not supported)

• to install specific Node version you can use nvm

  Example:

  • 1. nvm install 8.9.4
  • 2. nvm use v8.9.4
  • 3. Output Now using node v8.9.4 (npm v6.1.0)

• Hyperledger Composer
  • to install composer cli npm install -g composer-cli@0.19.4
  • to install composer-rest-server npm install -g composer-rest-server@0.19.4
  • to install generator-hyperledger-composer npm install -g generator-hyperledger-composer@0.19.4

Steps

1. Clone the repo
2. Generate the Business Network Archive
3. Deploy Network
   • Deploy to Fabric locally
   • Deploy to IBM Blockchain Starter Plan
4. Run Application

1. Clone the repo

Clone the Customer Loyalty Program with Blockchain repo locally. In a terminal, run:

git clone https://github.com/IBM/customer-loyalty-program

2. Generate the Business Network Archive

Next we will generate the Business Network Archive (BNA) file from the root directory.
This file will contain your network including:

• the model defined in the org.clp.biznet.cto file in the models folder
• the logic behind transactions in the logic.js file in the lib folder
• permissions defined in the permissions.acl file
• queries defined in the queries.qry file

Run the following the command to create the bna file:

cd customer-loyalty-program/
npm install

The composer archive create command in package.json has created a file called clp-network@0.0.1.bna.

3. Deploy Network

The bna can be deployed to a local instance of Fabric or can use IBM Blockchain Starter Plan.

• Deploy to Hyperledger Fabric locally
• Deploy to IBM Blockchain Starter Plan

4. Run Application

Go into the web-app folder and install the dependency:

cd web-app/
npm install

Start the application:

npm start

The application should now be running at: http://localhost:8000

Deploy application to IBM Cloud

If your hosting the network on IBM Blockchain Starter Plan, then you can deploy the app to IBM Cloud.

License

Apache 2.0