Index
b"# Koa-Box\nA truffle box to serve as the foundation of any Truffle and Koa.js dApp.\n\nThis Box Uses NodeJS(Koa JS) to provide API endpoints to the Ethereum Blockchain smart contract so that this smart contract can be used in Android/Ios Apps as well.\n\n- Production grade lightweight JSON based logging utility\n- configurable env's based on current NODE_ENV\n- Error handling middlewares\n- Easily pluggable controllers and routers\n- The project structure is highly modular and can be directly used or extended for production purpose\n\n**Pre-Requisites**\n1. [NodeJS](https://nodejs.org/en/)\n2. [Yarn](https://yarnpkg.com/lang/en/docs/install/#mac-stable) Or [NPM](https://www.npmjs.com/get-npm)\n3. [GanacheCLI](https://github.com/trufflesuite/ganache-cli)\n4. [Truffle](https://github.com/trufflesuite/truffle)\n\n**Installation**\n1. Install Truffle and Ganache CLI globally.\n\n```\nnpm install -g truffle\nnpm install -g ganache-cli\n```\n\n2. Download the box. This also takes care of installing the necessary dependencies.\n\n```\ntruffle unbox manjeet-thadani/koa-trufflebox\n\n```\n\n3. Install all the node modules required by running:\n```javascript\n// install all the node modules using npm\nnpm install\n``` \nor if you prefer yarn\n```javascript\n//install all the node modules using yarn\nyarn install\n```\n4. Start truffle development console using\n```\ntruffle develop\n```\n5. Inside the truffle console run `compile` to compile the contracts\n6. You can see that a new `/build` folder has been created in the root directory which contains the compiled contracts.\n\n7. Now these contracts need to be deployed on the Blockchain. For this, run `migrate` inside the truffle development console\n\n\n8. To run the Koa server `yarn start` or `npm start`\n9. In the browser window open `http://localhost:8081/`.\n\n**Collaborators**\n1. [MANJEET THADANI](https://github.com/manjeet-thadani)\n2. [CHIRAG MALIWAL](https://github.com/cmaliwal)\n"