QuickDapp CLI Documentation

The fastest way to scaffold production-ready Web3 dApps with Next.js, Foundry, and Thirdweb

Quick Start Installation User Flow Commands Environment

Quick Start

Get started with QuickDapp in seconds. Choose your preferred method:

Create a New Project

NPX (Recommended)

npx quickdapp my-awesome-dapp

Use Current Directory

npx quickdapp .

Specify Package Manager

npx quickdapp my-project --pm pnpm

Installation & Usage

Create New Project

NPX (Recommended)

Downloads and runs CLI without global install

npx quickdapp my-project-name

npx quickdapp my-crypto-wallet --pm pnpm

npx quickdapp trading-bot --pm npm

npx quickdapp defi-app --pm yarn

Global Installation

Installs CLI globally for repeated use

npm install -g quickdapp

quickdapp my-project-name

quickdapp my-project --pm pnpm

Current Directory

Creates project in current folder

npx quickdapp .

npx quickdapp . --pm pnpm

npx quickdapp ./ --pm yarn

Interactive Mode

Prompts for project name if not provided

npx quickdapp

User Flow (Step-by-Step)

Here's what happens when you run QuickDapp CLI:

Beautiful CLI Intro

ASCII art with creator branding welcomes you to QuickDapp

Project Name

Specify project name or use current directory

Package Manager Selection

Choose between pnpm, npm, or yarn with descriptions

Directory Check

Confirms if current directory is not empty

Template Cloning

Downloads the latest template from GitHub

Dependencies Installation

Installs all required packages using your chosen package manager

Smart Contract Setup

Foundry installation and smart contract compilation

Auto-Build Process

Builds contracts and Next.js application

Git Repository

Creates a fresh git repository (detached from template)

Success Message

Shows next steps and instructions to get started

Post-Installation Commands

Navigation

Navigate to your project

cd my-awesome-dapp

Development Commands (pnpm)

pnpm start

Starts production server on localhost:3000

pnpm dev

Starts development server with hot reload

pnpm build

Creates production build

pnpm quickdapp-dev

Compiles contracts + starts dev server with turbopack

pnpm quickdapp-build

Builds contracts + builds Next.js app

pnpm quickdapp-test

Tests contracts + lints Next.js code

pnpm quickdapp-init

Full setup: installs deps + builds + starts production

Development Commands (npm)

npm start

Starts production server on localhost:3000

npm run dev

Starts development server with hot reload

npm run build

Creates production build

npm run quickdapp-dev

Compiles contracts + starts dev server with turbopack

npm run quickdapp-build

Builds contracts + builds Next.js app

npm run quickdapp-test

Tests contracts + lints Next.js code

npm run quickdapp-init

Full setup: installs deps + builds + starts production

Development Commands (yarn)

yarn start

Starts production server on localhost:3000

yarn dev

Starts development server with hot reload

yarn build

Creates production build

yarn quickdapp-dev

Compiles contracts + starts dev server with turbopack

yarn quickdapp-build

Builds contracts + builds Next.js app

yarn quickdapp-test

Tests contracts + lints Next.js code

yarn quickdapp-init

Full setup: installs deps + builds + starts production

Environment Setup

Copy Environment Template

cp .env.local.example .env.local

Add Thirdweb API Keys

Add your Thirdweb API keys to .env.local:

.env.local

NEXT_PUBLIC_THIRDWEB_CLIENT_ID=your_client_id_here
THIRDWEB_SECRET_KEY=your_secret_key_here

Get API Keys from Thirdweb Dashboard

Package Manager Arguments

Uses pnpm (fast, efficient, disk space saving)

Uses npm (classic, most compatible)

Uses yarn (modern, good DX)

Smart Contract Commands

cd contracts

Navigate to contracts directory

forge install

Install contract dependencies

forge build

Compile smart contracts

forge test

Run contract tests

forge script script/Counter.s.sol --rpc-url <RPC_URL> --broadcast

Deploy contracts to blockchain

Features Overview

Modern UI/UX

Next.js 15 & Tailwind CSS for beautiful, responsive designs

Multi-Chain Support

Support for 80+ blockchains out of the box

AI Web3 Assistant

Built-in chatbot to help with Web3 development

Gasless Transactions

Thirdweb integration for seamless user experience

Smart Contracts

Foundry-powered development environment

Mobile Responsive

Optimized for all devices and screen sizes

TypeScript Ready

Fully typed for better developer experience

Production Ready

Optimized builds and deployment configurations

Contributing Guide

We welcome contributions to QuickDapp! Here's how you can help make it better.

Reporting Bugs

Found a bug? Please report it on our GitHub repository with detailed information:

Steps to reproduce the issue
Expected vs actual behavior
Environment details (OS, Node.js version, etc.)
Error logs or screenshots

Feature Requests

Have an idea for a new feature? Open an issue with the "enhancement" label and describe:

The problem you're trying to solve
Your proposed solution
Alternative solutions considered
Additional context or examples

Pull Request Process

Fork the repository and create your branch from main
Make your changes and ensure tests pass
Update documentation if needed
Follow the existing code style and conventions
Write clear, descriptive commit messages
Submit your pull request with a detailed description

Development Setup

Clone and setup

git clone https://github.com/moayaan1911/quickdapp.git
cd quickdapp-package
npm install
npm run build

Follow the development guidelines in the repository's CONTRIBUTING.md file.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Be respectful, inclusive, and collaborative in all interactions.

Troubleshooting

Node.js Version Requirements

QuickDapp requires Node.js 18.0.0 or higher.

node --version

If you need to update Node.js, visit nodejs.org or use a version manager like nvm.

Permission Errors

If you encounter permission errors when installing globally:

sudo npm install -g quickdapp

Or configure npm to use a different directory for global packages.

Network/Firewall Issues

If you're behind a corporate firewall or experiencing network issues:

Configure npm proxy settings if needed
Try using a different registry: npm config set registry https://registry.npmjs.org/
Check if your firewall blocks GitHub access

Build Failures

If builds fail, try these steps:

Clear npm cache: npm cache clean --force
Delete node_modules and reinstall: rm -rf node_modules package-lock.json && npm install
Check for Node.js/npm version compatibility
Ensure you have sufficient disk space

API Reference

Complete CLI options and flags available in QuickDapp:

Command Syntax

quickdapp [project-name] [options]

Show help information and usage examples

Display the current version of QuickDapp CLI

Choose package manager (pnpm, npm, yarn)

Examples:

--pm pnpm
--pm npm
--pm yarn

Creator Credits

Built by Mohammad Ayaan Siddiqui

Full-stack developer passionate about Web3 and making blockchain development accessible to everyone.

Website Email GitHub

Important Links

Main Template Repository

The core QuickDapp template

CLI Package Repository

The npm package source code

Thirdweb Dashboard

Get your API keys

NPM Package

View on npm registry