create-fhenix-dapp

Create Fhenix DApp

Fhenix Documentation | Scaffold ETH Documentation | Scaffold ETH Website

🧪 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 NextJS, RainbowKit, Hardhat, Wagmi, Viem, 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 network.

Requirements

Before you begin, you need to install the following tools:

• Node (>= v18.17)
• pnpm
• Git

Quickstart

To get started with Create Fhenix DApp, follow the steps below:

• Install from NPM Registry and follow the CLI instructions.

npx create-fhenix-dapp@latest

• Run a local network in the first terminal:

pnpm chain:start

This command starts a local Ethereum network using Hardhat or Foundry, depending on which one you selected in the CLI. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in:

• packages/backend/hardhat.config.ts if you have Hardhat as solidity framework.

This command fund the default deployer contract to be able to deploy to the local node.

• On a second terminal, deploy the test contract:

pnpm deploy:contracts

This command deploys a test smart contract to the local network. The contract can be modified to suit your needs. Is located in:

• Hardhat => packages/backend/contracts

The pnpm deploy:contracts command uses a deploy script to deploy the contract to the network. You can customize it. Is located in:

• Hardhat => packages/backend/deploy

• On a third terminal, start your NextJS app:

pnpm start

• (optional) When you finish your work, stop the local Fhenix node:

pnpm chain:stop

Visit your app on: http://localhost:3000. You can interact with your smart contract using the Debug Contracts page. You can tweak the app config in packages/frontend/scaffold.config.ts.

Run smart contract test with pnpm hardhat:test.

• Edit your smart contract:
  • Hardhat => YourContract.sol in packages/banckend/contracts
• Edit your frontend in packages/frontend/pages
• Edit your deployment scripts:
  • Hardhat => packages/backend/deploy

Documentation

• Fhenix Website
• Fhenix Documentation
• Scaffold ETH Documentation

Roadmap

• Finish the Fhenix Counter demo
• Fix issue: backend: pnpm prepare$ install-self-peers -- --ignore-scripts│  ERR_PNPM_MISSING_PACKAGE_NAME  pnpm add requires the package name
• Fix issue: package.json files of the scaffolded instance are minimized (which is wrong)

Contributing to Create Fhenix DApp

TBD