Getting Started

Pre-requisites

Before we get started, these are the tools you’ll need to develop your DappStarter project:

Installation

Using a terminal (or command prompt), change to the folder containing the project files and type: yarn

This will fetch all required dependencies. The process will take 1-3 minutes and while it’s in progress, you can move on to the next step.

Note: You may see npm warnings about "web3-bzz" after dependencies are installed. These can be ignored as the associated code is never invoked.

Build, Deploy and Test

Using a terminal (or command prompt), change to the folder containing the project files and type: yarn start This will run all the dev scripts in each project package.json.

To view your dapp, open your browser to http://localhost:5000

Other Scripts

If you prefer to run scripts individually, the order is:

Smart Contract

lerna run deploy --scope=@trycrypto/dappstarter-dapplib --stream to compile contracts/*.sol files, deploy them to the blockchain.

Dapp

Run the dapp in a separate terminal. You must have run npm run deploy for the dapp to see the most recent smart contract changes.

lerna run dev --scope=@trycrypto/dappstarter-client --stream runs the dapp on http://localhost:5001 using webpack dev server

Server

Run the server in a separate terminal. You must have run npm run deploy for the dapp to see the most recent smart contract changes.

lerna run dev --scope=@trycrypto/dappstarter-server --stream runs NodeJS server app on port 5002 with NestJS

Testing

test-config.js contains settings used by test scripts

Run tests using lerna run test [test file] --scope=@trycrypto/dappstarter-dapplib --stream

Production Builds

DappStarter currently does not provide blockchain migration scripts to be used in production. However, here are the scripts for generating production builds:

lerna run build:prod generates dapp bundle for production.