create-fhenix-dapp
v0.3.0
Published
Create Fhenix DApp
Downloads
9
Maintainers
Readme
Create Fhenix DApp
🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Fhenix blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.
⚙️ Built using Scaffold ETH, Next.js, RainbowKit, Hardhat, Wagmi, Viem, Ethers.js, Fhenixjs, and Typescript.
- ✅ Contract Hot Reload: Your frontend auto-adapts to your smart contract as you edit it.
- 🪝 Custom hooks: Collection of React hooks wrapper around wagmi to simplify interactions with smart contracts with typescript autocompletion.
- 🧱 Components: Collection of common web3 components to quickly build your frontend.
- 🔥 Burner Wallet & Local Faucet: Quickly test your application with a burner wallet and local faucet.
- 🔐 Integration with Wallet Providers: Connect to different wallet providers and interact with the Ethereum/Fhenix network.
- Fhenix tools: fhenix-hardhat-docker, fhenix-hardhat-plugin and fhenixjs for a quick start with Fhenix.
Requirements
Before you begin, you need to install the following tools:
Quickstart
To get started with Create Fhenix DApp, follow the steps below:
- Install and run it:
pnpm create fhenix-dapp@latest
- Run a local network:
pnpm chain:start
This command starts a local Fhenix node using Hardhat and Docker for testing and development.
You can customize the network configuration in packages/backend/hardhat.config.ts
.
- Deploy a demo contract to the local network:
pnpm deploy:contracts
Note: The default deployer contract will be automatically funded to be able to deploy to the local node.
The contract can be modified here: packages/backend/contracts
The contract deployment script can be customized here: packages/backend/deploy
- (optional) Run smart contract tests to make sure it's been deployed successfully:
pnpm test
- Then start your Next.js app:
pnpm start
Visit your app on: http://localhost:3000
. You can interact with your smart contract using the Debug Contracts
page of the Counter demo on the frontpage.
You can tweak the app config in packages/frontend/scaffold.config.ts
.
- (optional) When you finish your work, stop the local Fhenix node to release resources:
pnpm chain:stop
Development entry points
- Tweak the app config in
packages/frontend/scaffold.config.ts
. - Edit the demo smart contract:
packages/backend/contracts/Counter.sol
- Edit your frontend in
packages/frontend/app
- Edit your deployment scripts:
packages/backend/deploy
Documentation
- Fhenix Website
- Fhenix Documentation
- Scaffold ETH Documentation
Extend/develop this project
Check out Wiki
Credits
Many thanks to Scaffold ETH developers for providing a solid foundation for this project.