Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shardeum/shardeum-dapp-boilerplate
A ready-to-go configurable boilerplate for blockchain projects.
https://github.com/shardeum/shardeum-dapp-boilerplate
blockchain boilerplate dapp shardeum web3
Last synced: 5 days ago
JSON representation
A ready-to-go configurable boilerplate for blockchain projects.
- Host: GitHub
- URL: https://github.com/shardeum/shardeum-dapp-boilerplate
- Owner: shardeum
- Created: 2023-10-18T13:37:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-18T21:58:28.000Z (5 months ago)
- Last Synced: 2025-01-01T22:07:53.078Z (12 days ago)
- Topics: blockchain, boilerplate, dapp, shardeum, web3
- Language: JavaScript
- Homepage:
- Size: 581 KB
- Stars: 50
- Watchers: 4
- Forks: 31
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Shardeum Dapp Boilerplate
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
## 🚀 Getting Started
### Option 1: Direct Setup
```bash
npx create-shardeum-dapp-boilerplate@latest --name test-project
cd test-project
npm run dev
```
Your boilerplate is now ready and running on your local machine!
### Option 2: Manual Setup
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
```
## 📖 Use Cases
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 lets a user mint NFTs for a fixed mint price.
- DeFi: This module demonstrates the use of Uniswap V2 to swap between two tokens.
## 🛠️ Layout
- **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.
## ✨ Contributing Guidelines
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.