create web3 dapp
1.0.0
Everything you need to create Web3 Dapps in 4 minutes.
This package includes the global command to start the Create Web3 DApp CLI builder.
Please refer to this package's documentation and the following links for an in depth explanation:
? No need to clone: run "npx create-web3-dapp@latest" in your terminal to get started
Your environment will have everything you need to start building a dapp:
With create-web3-dapp you can create multi-chain dapps supporting all of the major EVM based chains:
Support for non EVM chains is in the roadmap
create-web3-dapp is an npx tool that allows developers to create web3 applications in ~4 minutes.
The dapp created with create-web3-dapp are NextJS-based, and compatible with the most used blockchains such as Ethereum, Polygon, Optimism, Arbitrum, and Solana. Create-web3-dapp allows web3 developers to build production-ready decentralized applications at lightning speed, using pre-made React components, webhooks, and APIs.
No complicated configuration or folder structures, only the files you need to build your Dapp.
One Dependency: There is only one build dependency. It uses webpack, Babel, ESLint, and other amazing projects, but provides a cohesive curated experience on top of them.
No Configuration Required: You don't need to configure anything. A reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.
No Lock-In: You can “eject” to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off.
Create web3 dapp is a great fit for:
npx create-web3-dapp@latest
If you've previously installed create-web3-dapp globally via npx create-web3-dapp, the CLI builder will notify you if a new version has been released. In any case, we suggest you to run using the latest available version by running npx create-web3-dapp@latest.
(npx comes with npm 5.2+ and higher, see instructions for older npm versions)
To create a new app:
npx create-web3-dapp@latestCreate web3 dapp will then create a directory containing the files to kickstart your project and install the install dependencies you'll need
npx create-web3-dapp@latest
cd my-create-web3-dapp
npm run devIn case you've installed a blockchain development environment, navigate to the frontend folder before running npm run dev.
Now navigate on http://localhost:3000/ to see your dapp.
Next, learn how to add a web3 ready component from the create-web3-dapp library.
Create web3 dapp doesn't only set up your blockchain development environment, that to the built-in smart contracts backpack it also allows to create fully fledged Solidity Smart Contracts directly from the CLI.
Note: This will work only if you have installed a blockchain development environment
The smart contracts backpack can create audited smart contracts, deployment scripts and tests, of one of the following standards:
Learn more on how to create, build and deploy, the smart contracts backpack in the docs.
Create web3 dapp allows developers to prototype their dapps in minutes thanks to a full library of responsive, production ready, web3 React components.
Note: The components work best inside create-web3-dapp projects, but are compatible with any NextJS project.
Use the following links to learn how to implement the components in the library:
import styles from "../styles/Home.module.css";
import NftCreator from "../components/nft-creator";
import contract from "../abis/smartContractAbi.json";
export default function Home() {
return (
<div>
<main className={styles.main}>
<NftCreator
abi={contract.abi}
contractAddress={
"0x9FaCAf075Cda7C0947DA0F0B4164332e01422E97"
}
/>
</main>
</div>
);
}More components? Check detailed instructions on the Docs.
Create web3 dapp gives you access to a library of production ready, web3 applications to kickstart your project with. NFTs Explorer, and much more coming soon.
The templates are available for developers to use as is, or they can be customized to fit the needs of their particular project.
Note: keeping dependencies to the minimum, and the code lean is our top priority, this to grant the templates, full customisability.
Use the following links to learn how to kickstart your dapp using the templates library:
create-web3-dapp has two folders structures, based on the presence of a blockchain development environment, or not.
?Root
┣ components
┃ ┣ navigation
┃ ┃ ┗ navbar.jsx
┃ ┗ InstructionsComponent.jsx
┣ layout
┃ ┗ mainLayout.jsx
┣ pages
┃ ┣ api
┃ ┣ _app.js
┃ ┗ index.jsx
┣ public
┃ ┗ alchemy_logo.svg
┣ styles
┃ ┣ Home.module.css
┃ ┣ Navbar.module.css
┃ ┣ InstructionsComponent.module.css
┃ ┗ globals.css
┣ .env.local
┣ .gitignore
┣ next.config.js
┣ package-lock.json
┗ package.json
?Root
┣ .vscode
┃ ┗ settings.json
┣ backend
┃ ┣ contracts
┃ ┃ ┗ MyContract.sol
┃ ┣ scripts
┃ ┃ ┗ MyContract_deploy.js
┃ ┣ test
┃ ┃ ┗ Lock.js
┃ ┣ .env.local
┃ ┣ hardhat.config.js
┃ ┣ package-lock.json
┃ ┗ package.json
┣ frontend
┃┣ components
┃ ┃┣ navigation
┃ ┃ ┗ navbar.jsx
┃ ┃┗ InstructionsComponent.jsx
┃┣ layout
┃┃ ┗ mainLayout.jsx
┃┣ pages
┃┃ ┣ api
┃┃ ┣ _app.js
┃┃ ┗ index.jsx
┃┣ public
┃┃ ┗ alchemy_logo.svg
┃┣ styles
┃┃ ┣ Home.module.css
┃┃ ┣ Navbar.module.css
┃┃ ┣ InstructionsComponent.module.css
┃┃ ┗ globals.css
┃┣ .env.local
┃┣ .gitignore
┃┣ next.config.js
┃ ┣ package-lock.json
┃ ┗ package.json
┣ .DS_Store
┣ .env.local
┣ .gitignore
┣ LICENSE
┗ README.md
We'd love to have your helping hand on create-web3-dapp! See contributing.md for more information on what we're looking for and how to get started.
Create Web3 DApp is a community maintained project and all contributors are volunteers. If you'd like to support the future development of Create React App then please consider donating to our Open Collective.
This project exists thanks to all the people who contribute.
Create React App is open source software licensed as GNU-AGPL.
