This boilerplate allows everyone to easy start when building an æpp with ReactJS on top of the æternity ecosystem.
This boilerplate detects any Aeternity compatible wallets installed, if yes then connects to it.
Provides a variable aeSdk
which could be used to interact with the Wallet and the Aeternity Blockchain.
Clone repo via git or use the template button above.
Install the dependencies
npm install
For development purposes (hot-reloading)
npm start
# npm run start:testnet
# npm run start:mainnet
To build the bundle for production
npm run build
For running the integration tests
npm test
We engineered this GitHub Action config to be as versatile as possible while being transparent to the developer. There are no hidden config files and a minimal set of presets where necessary.
build_and_deploy.yml
: This Action configuration file named æpp CI/CD is used to build and deploy the æpp boilerplate. It represents a GitHub Action file that performs actions on push changes to branches. The action config performs two main jobs of building and deployment.
The build job installs the required NPM dependencies using three recent node versions then runs test suite and executes the npm run build
command to prepare the production-ready files for deployment.
The deploy job continues the action workflow to deploy the already prepared production-ready files using gh-pages. This deploy process creates/updates the gh-pages branch that previews the æpp-boilerplate via the provided GitHub Repo Page Link.
This dependency is imported and should work out of the box with this implementation. An initialized client is provided by the useAeternitySDK.ts
file as used in the App.js
file to discover a connected wallet.
Since we aim to make this boilerplate as universally connective as possible, we implemented an easy wallet discovery feature to get the connected Superhero wallet address and AE balance. This process started from the useAeternitySDK.ts
file that uses the imported @aeternity/aepp-sdk
dependency. That file exposes SDK instance the same as method to connect to wallet, reactive variables to get current address and network id.
The useAeternitySDK.ts
module is then used in the App.js
file to get the connected wallet address and initialized client that provides the AE balance for the connected address.