SHIPMENT LOG

SHIPMENT LOG is a platform for Blockchain integration in freight shipping infrastructure. This helps in

• Improving the security and traceability of shipments.
• Can easily implement policies and contracts into the system.
• Thus reduce the paperwork and will improve efficiency.
• Widely reducing the clearance time.
• Enables to know the progress of shipments.

Table of contents

• Table of contents
• What's included
• Features
• Documentation
  • Tech Stack
  • Use Case
  • WorkFlow Diagram
  • Network
  • Project Walk through
  • Run Locally
    • Prerequisite
    • Installation
  • API Reference
• Running Tests
  • Used Environment
  • Testing Tool
  • Testing Block Event
• Screenshots
• Authors
• License

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

Shipment-Log/
├── client/(front-end data)
├── network/
│   ├── README.md
│   ├── requirements.yml
│   └── shipping.yml
├── server/
│   ├── lib/www
│   ├── public/(docs)
│   ├── routes/
│   |   ├── clientApp.js
│   |   ├── events.js
│   |   ├── index.js
│   |   └── profile.js
│   ├── app.js
│   ├── package-lock.json
│   └── package.json
├── smartcontract/
│   ├── lib/
│   |   └── shipment-contract.js
│   ├── private/
│   |   └── privateData.json
│   ├── test/
│   |   └── shipment-contract.js
│   ├── transaction_data/
│   |   └── shipment-transaction.txdata
│   ├── .editorconfig
│   ├── .eslintignore
│   ├── .eslintrc.js
│   ├── .gitignore
│   ├── .npmignore
│   ├── .prettierrc.js
│   ├── index.js
│   ├── package-lock.json
│   └── package.json
├── .gitignore
├── LICENSE
└── README.md

Features

• Fluid Design UI
• Animations
• Notifications
• Form Validations
• Block Events
• Tracking of Shipment
• Infotainment Tabs
• Private Data Collection

Documentation

Tech Stack

Client: React, NextJs, Bootstrap
Server: Node, Express

Use Case

Use Case Documentation

WorkFlow Diagram

Network

Network Documentation

Project Walk through

Run Locally

Prerequisite

• Docker v.19.03x+
• Docker Compose
• Hyperledger Fabric Binaries And Docker Images
• Golang v.1.13.x+
• Node Js v.10.x+
• npm v.6.x+
• Visual Studio Code v.1.40+
• IBM Blockchain Extension v.2.x+
• Sponge
• jq

Installation

Clone the project

  git clone https://gitlab.com/Justinjdaniel/chfvb601_-shipping.git

Setup Network refer Network

Instruction	Server	Client
Go to the directory	cd chfvb601_shipping/server	cd chfvb601_shipping/client
Install dependencies	npm install	npm install
Start	npm start	npm run dev

Client Readme

API Reference

Detailed Documentations in

  http://localhost:5000/

Method	API end point	Description
POST	/create	Create a shipment
GET	/read	Read shipment details
POST	/approval	Add approval of shipment
POST	/verification	Add verification of shipment
POST	/clearance	Add clearance of shipment
POST	/receipt	Add receipt of shipment
POST	/privateSend	Add private data of shipment
GET	/privateCall	Read private data of shipment

Running Tests

Used Environment

• Machine : MacBook Pro M1
• OS : macOS Big Sur
• Platforms : x86-64, ARM64

Testing Tool

• Visual Studio Code v.1.39
• Mocha Test Explorer

Testing Block Event

Screenshots

Authors

• @Justinjdaniel

License

MIT