Create BlockDAG dApp

A lightweight CLI tool to quickly scaffold BlockDAG decentralized applications with a ready-to-use structure.

Quick Start

npx create-blockdag-dapp@latest

This command will prompt you for a project name, clone the starter kit, and install initial dependencies.

Features

• Streamlined Setup: Create a complete BlockDAG application foundation with a single command.
• Modern Stack: Next.js 14+ frontend with TypeScript and Tailwind CSS.
• Dual Smart Contract Environments: Includes both Hardhat (JS/TS) and Foundry (Solidity) setups.
• Web3 Integration: Basic wallet connection setup included in the frontend.
• Clean Start: Initializes a fresh Git repository for your project.

Project Structure

The created project follows this structure:

your-app/
├── frontend/
│   ├── src/
│   ├── public/
│   ├── tailwind.config.ts
│   └── package.json
└── contracts/
    ├── hardhat/
    │   ├── contracts/
    │   ├── scripts/
    │   ├── test/
    │   └── hardhat.config.ts
    └── foundry/
        ├── src/
        ├── test/
        ├── script/
        └── foundry.toml

Environment Setup

After the CLI finishes, you'll need to set up environment variables:

1. Frontend (frontend/.env.local)

Copy frontend/.env.example to frontend/.env.local and add your WalletConnect Project ID:

NEXT_PUBLIC_WALLET_CONNECT_PROJECT_ID=your_wallet_connect_project_id

(Get this from cloud.walletconnect.com).

2. Smart Contracts (contracts/hardhat/.env and contracts/foundry/.env)

In both the contracts/hardhat and contracts/foundry directories, copy the .env.example file to .env and add your details:

PRIVATE_KEY=your_private_key_here
RPC_URL=your_rpc_url_here

Development Workflow

1. Create Project: npx create-blockdag-dapp@latest (Installs frontend & hardhat dependencies automatically).
2. Navigate: cd your-project-name
3. Setup Envs: Create and configure your .env files as described above.
4. Install Foundry Libs: cd contracts/foundry && forge install
5. Start Frontend: cd ../../frontend && npm run dev (or yarn dev)

Running Commands

Frontend

cd frontend
npm run dev # Start development server
# or yarn dev

Hardhat

cd contracts/hardhat
npm run compile # or npx hardhat compile
npm run test    # or npx hardhat test
# See package.json for deployment scripts

Foundry

cd contracts/foundry
forge build
forge test
forge install # If you haven't already
# See README in foundry directory for deployment

License

MIT