Skip to content

Latest commit

 

History

History
68 lines (56 loc) · 2.49 KB

README.md

File metadata and controls

68 lines (56 loc) · 2.49 KB
Raw

Express-Box

To Be Used as Truffle Box Creating API Endpoints for Ethereum Blockchain.

We use personalised blockchain for Ethereum BlockChain Development. This personalised blockchain is made in the GanacheCLI.

The Smart Contract Written in solidity language is deployed on this Ethereum Blockchain. Smart Contract is Immutable hence, once deployed it can't be changed.

A truffle box to serve as the foundation of any Truffle and Express.js dApp.

This Box Uses NodeJS(Express JS) to provide API endpoints to the Ethereum Blockchain smart contract so that this smart contract can be used in Android Apps as well.

Pre-Requisites

  1. NodeJS
  2. Yarn
  3. GanacheCLI
  4. Truffle

Installation

  1. Install Truffle and Ganache CLI globally. If you prefer, the graphical version of Ganache works as well!
npm install -g truffle
npm install -g ganache-cli
  1. Download the box. This also takes care of installing the necessary dependencies.
truffle unbox arvindkalra/express-box
  1. In one terminal window run the Launch GanacheCLI ganache-cli -i 666
  • To prevent creating a new network id everytime, we have set a default network key in the truffle config file.
  • To change that, simply go to the 'truffle.js' file and change the network_id from '666' to " * " and to Launch GanacheCLI ganache-cli.
  1. Install all the node modules required by running:
// install all the node modules using npm
npm install

or if you prefer yarn

//install all the node modules using yarn
yarn install
  1. Open another terminal window in the project repository and compile all the smart contract(which can be found in the '/contracts' folder).
truffle compile

  1. You can see that a new /build folder has been created in the root directory which contains the compiled contracts.

  2. Now these contracts need to be deployed on the Blockchain. For this,

truffle migrate --network development
  • If you changed the network_id to " * " in Step 1, you can run truffle migrate
  1. To run the Express server yarn start or npm server.js
  2. In the browser window open http://localhost:3000/.

Collaborators

  1. ARVIND KALRA
  2. PRANAV SINGHAL