Create Rootstock Dapp

A CLI tool to create Rootstock dapps with a modern tech stack and best practices.

Quick Overview

npx create-rootstock-dapp my-dapp
cd my-dapp
npm run dev

If you've previously installed create-rootstock-dapp globally, we recommend you uninstall the package to ensure you're always using the latest version:

npm uninstall -g create-rootstock-dapp

Creating a Dapp

To create a new app, you may choose one of the following methods:

npx

npx create-rootstock-dapp my-dapp

npm

npm init rootstock-dapp my-dapp

Yarn

yarn create rootstock-dapp my-dapp

Options

• --use-npm - Use npm instead of yarn for package management
• --template <template-name> - Specify a template (default: "default")

Templates

Default Template

The default template includes:

• Next.js 13+ with App Router
• TypeScript support
• TailwindCSS for styling
• Foundry for smart contract development
• RainbowKit for wallet connection
• wagmi for contract interactions
• Modern UI components
• Example Counter contract
• Comprehensive documentation

Features

• 🚀 Quick start with pre-configured tools
• 🔒 Security best practices for smart contracts
• 💅 Beautiful and responsive UI
• 📱 Mobile-first design
• 🌐 Web3 integration ready
• 🧪 Testing setup included
• 📖 Comprehensive documentation

Project Structure

my-dapp/
├── frontend/          # Next.js frontend
│   ├── src/
│   │   ├── app/      # Next.js app router
│   │   ├── components/
│   │   └── config/
├── contracts/         # Foundry project
│   ├── src/          # Smart contracts
│   └── script/       # Deployment scripts
└── README.md

Contributing

We'd love your help! Please read our contributing guide to learn about our development process.

License

Create Rootstock Dapp is open source software licensed under the MIT license.