Yeoman generator of Harmony DApp Scaffold.
Please note that this generator only works under POSIX compatible environments.
- Install Node.js(>=12) & npm(>=7): https://nodejs.org/en/download/
- Install Docker Engine & CLI Client: https://docs.docker.com/engine/
- Install Harmony One Wallet Chrome extension: https://chrome.google.com/webstore/detail/harmony-one-wallet/fnnegphlobjdpkhecapkijjdkgcjhkib
First, install Yeoman and generator-scaffold-harmony using npm (we assume you have pre-installed node.js).
npm install -g yo
npm install -g generator-scaffold-harmony
Then generate your new project:
mkdir my-harmony-dapp && cd my-harmony-dapp
yo scaffold-harmony
- UI/UX React boilerplate code for DApp
- Simple UI with Home Page
- Connection to as many popular wallets as possible
- OneWallet
- Mathwallet
- Simple interaction with demo contract
- Tests for UI/UX application
- Smart contract:
- Something simple but more than Hello World so that it can interact with UX/UI
- Tests
- Development environment (CLI):
- CLI command to create sandbox env for both contract (Ganache) and UX/UI (React) so that it can run on localhost.
- CLI command to deploy contract to testnet/mainnet.
- CLI command to run tests for both contract and UX/UI.
- README:
- Installation guide (any dependencies etc.)
- Basic usage on how to run and interact with template.
- Document CLI.
- Provide extra resources and "kickstart" documentation links for developers.
- Document how to deploy React application (simplified). https://create-react-app.dev/docs/deployment/
- Nice-to-have
- Would be nice to use tool like cookiecutter to make template customizable with Author, App Name, Software Versions, Tags, Logos and other things that might be non-static.
- Include CI workflow (probably easiest to use git workflow) to run test on push.