This project is for the blockchain application My Dapp. It contains code for the Smart Contract, web-based dapp and NodeJS server.
In order to develop and build "My Dapp," the following pre-requisites must be installed:
- Visual Studio Code (or any IDE for editing Javascript)
- NodeJS
- Yarn (DappStarter uses Yarn Workspaces)
Before you proceed with installation, it's important to note that many blockchain libraries either don't work or generate errors on Windows. If you try installation and can't get the startup scripts to completion, this may be the problem. In that case, it's best to install and run DappStarter using Windows Subsystem for Linux (WSL). Here's a guide to help you install WSL.
Blockchains known to require WSL: Solana
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 is in progress you can move on to the next step.
You might see failures related to the node-gyp package when Yarn installs dependencies.
These failures occur because the node-gyp package requires certain additional build tools
to be installed on your computer. Follow the instructions for adding build tools and then try running yarn again.
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.
Here are the locations of some important files:
- Contract Code: packages/dapplib/contracts
- Dapp Library: packages/dapplib/src/dapp-lib.js
- Blockchain Interactions: packages/dapplib/src/blockchain.js
- Unit Tests: packages/dapplib/tests
- UI Test Harnesses: packages/client/src/dapp/harness
To view your dapp, open your browser to http://localhost:5000 for the DappStarter Workspace.
We
yarn migrate to compile contracts/*.sol files, deploy them to the blockchain.
Run the dapp in a separate terminal. You must have run npm run deploy for the dapp to see most recent smart contract changes.
yarn dapp runs the dapp on http://localhost:5001 using webpack dev server
Run the server in a separate terminal. You must have run npm run deploy for the dapp to see most recent smart contract changes.
yarn server runs NodeJS server app on port 5002 with NestJS
test-config.js contains settings used by test scripts
Run tests using yarn test --script=[test file]
DappStarter currently does not provide blockchain migration scripts to be used in production. However, here are the scripts for generating production builds:
yarn build:prod generates dapp bundle for production.