Accelerate your web3 creativity with the Build Onchain Apps Toolkit. ☕️
Build Onchain Apps Toolkit takes an opinionated approach to streamlining and automating early decisions you must make when building your consumer product.
The generated onchain app aims to provide everything you need to run a web product, along with additional tools, documentation, and tricks for building onchain.
Whether you're a hackathon participant or an ambitious entrepreneur looking to establish the next successful company, this toolkit is designed with you in mind. 💙
Building blocks out of the box 🧰 🧙 ✨
- Web: Next.js + Tailwind CSS + Radix UI 🟡
- Onchain: Base + RainbowKit + wagmi + Viem 🔵
- Experiences: send, mint 🌁
- Onchain UI components: AccountConnectButton 🎨
- Support EOA Wallet integration 👛
- Linting and Prettier 💅
- Tests Suite
- Support Progressive Web Apps ⚡️
- Foundry integration
- Web Vitals analytics
- In-depth step by step documentation (Coming Soon)
- Onchain UI components: Balances, Minting, Airdrop, etc...
- We just started; stay tuned for more to come!!! ☕️
npx @coinbase/build-onchain-apps@latest create
Step 1.1: Obtain Wallet Connect Project ID from walletconnect.com and assign to the .env.local
file
NEXT_PUBLIC_WALLET_CONNECT_PROJECT_ID=ADD_WALLET_CONNECT_PROJECT_ID_HERE
# Install dependencies
yarn
# Run onchain app
yarn dev
# Install Foundry
curl -L https://foundry.paradigm.xyz | bash
foundryup
cd contracts
# Install dependencies
forge install
# Build
forge build
# Test
forge test
# Format
forge fmt
Create a .env
file using the .env.example
file provided in your contracts folder and add your private key.
source .env
forge script script/BuyMeACoffee.s.sol:BuyMeACoffeeScript --broadcast --verify --rpc-url ${RPC_URL} --etherscan-api-key ${BLOCK_EXPLORER_API_KEY}
Read below to learn how you can take part in improving Build Onchain Apps Toolkit.
To build and test either the CLI or the main App, start by cloning the repo.
# Clone the repo
git clone https://github.com/coinbase/build-onchain-apps.git
# Go to main application
cd apps/build-onchain-apps
# Install and run latest template
yarn
yarn dev
# From the root repo
# Install and build latest dependencies
yarn
yarn build
# Link the local package to the global npm registry
npm link
# Test CLI using the local package
build-onchain-apps create
# After testing, unlink the package from the global npm registry
npm unlink @coinbase/build-onchain-apps
npm uninstall -g @coinbase/build-onchain-apps
Build Onchain Apps Toolkit is all about community; for any questions, feel free to:
- Open an issue
- Tell us what project you build ⛵️
- Reach out to the core maintainers on Twitter or Farcaster
Leonardo Zizzamia |
Sneh Koul |
Alvaro Raminelli |
Wesley Pickett |
Chris Nascone |
Rose Kuan |
Rob Polak |
This project is licensed under the MIT License - see the LICENSE.md file for details