Welcome to the Shardeum Dapp Boilerplate repository! This is a comprehensive starting point for rapid prototyping your ideas on Shardeum.
This boilerplate is great for:
✅ Learning Blockchain fundmentals
✅ Hackathon participants
✅ Experiencing Shardeum
To quickly set up the Shardeum dApp Boilerplate, you can use our npm library. This will clone the repository, install all dependencies, and create a project named test-project with the boilerplate inside it.
Run the following command in your terminal:
npx create-shardeum-dapp@latest --name test-projectAfter the process completes, navigate to your new project and start the development server:
cd test-project
npm run devYour boilerplate is now ready and running on your local machine!
Alternatively, you can manually set up the boilerplate by cloning the repository and installing the necessary dependencies:
git clone https://github.com/Shardeum/shardeum-dapp-boilerplate
cd shardeum-dapp-boilerplate
npm install
npm run dev
There are three primary modules in the boilerplate:
-
RPC: This module demonstrates the functionality of an Shardeum RPC. Be in reading useful data from the blockchain or sending transactions, rpcs serve as a gateway to the blockchain.
-
NFT Minting: This module demonstrates a basic NFT minting page which let's user mint NFTs for a fixed mint price.
-
DeFi: This module demonstrate the use of Uniswap V2 to swap between two tokens.
-
Header: An easily configurable header with wallet connect functionality along with displaying user address and balance.
-
Pages: Individual pages for demonstrating functionality for 3 major verticals in web3 - RPC, NFT and Defi.
-
Smart Contracts: All primary smart contracts used in the application can be found in the 'contracts' directory and the appropriate scripts in the 'scripts' directory.
We warmly welcome contributions to the Shardeum Dapp Boilerplate! Whether you're fixing bugs, adding new features, or improving documentation, your help makes a big difference.