Quickstart

A powerful CLI tool for generating customizable Celo blockchain starter kits with modern monorepo architecture.

Prerequisites

• Node.js >= 18.0.0
• PNPM (recommended) or npm/yarn

Quick Start

Create a new Celo project in seconds:

npx @celo/celo-composer@latest create

This will start an interactive setup process where you can choose your template, wallet provider, and smart contract framework.

Installation

No installation required! Use npx to run Celo Composer directly without installing anything globally.

Usage

Interactive Mode

Run the command without any flags to enter interactive mode:

npx @celo/celo-composer@latest create my-celo-app

The CLI will guide you through:

• Project name and description
• Template selection
• Wallet provider choice
• Smart contract framework selection
• Dependency installation

Non-Interactive Mode

Create a project with specific configurations using flags:

npx @celo/celo-composer@latest create my-celo-app \
  --template basic \
  --wallet-provider rainbowkit \
  --contracts hardhat \
  --description "My awesome Celo app"

Quick Start with Defaults

Skip all prompts and use default settings. This will create a basic app with no additional setup:

npx @celo/celo-composer@latest create my-celo-app --yes

Available Templates

Basic Web App (default)

A standard Next.js 14+ web application with modern UI, perfect for most dApp projects.

npx @celo/celo-composer@latest create --template basic

Farcaster Miniapp

A specialized template for building Farcaster Miniapps with Farcaster SDK and Frame development support.

npx @celo/celo-composer@latest create --template farcaster-miniapp

MiniPay App

Optimized for building dApps that integrate with the MiniPay mobile wallet, with mobile-first design.

npx @celo/celo-composer@latest create --template minipay

Checkout minipay docs to learn more about it.

AI Chat App

A standalone Next.js AI chat application template.

npx @celo/celo-composer@latest create --template ai-chat

Wallet Providers

Choose a wallet provider to handle user authentication and transaction signing:

• RainbowKit (default): Popular, easy-to-use wallet connector for React apps
• Thirdweb: Complete Web3 development framework with powerful wallet tools
• None: Skip wallet integration if you want to integrate your own solution

npx @celo/celo-composer@latest create --wallet-provider rainbowkit

Smart Contract Frameworks

Set up a smart contract development environment:

• Hardhat (default): Popular Ethereum development environment
• Foundry: Fast, portable and modular toolkit for Ethereum application development
• None: Skip smart contract development setup

npx @celo/celo-composer@latest create --contracts hardhat

Command Options

npx @celo/celo-composer@latest create [project-name] [options]

Flag	Description	Default
-d, --description <description>	Project description	Interactive prompt
-t, --template <type>	Template type (basic, farcaster-miniapp, minipay, ai-chat)	basic
--wallet-provider <provider>	Wallet provider (rainbowkit, thirdweb, none)	rainbowkit
-c, --contracts <framework>	Smart contract framework (hardhat, foundry, none)	hardhat
--skip-install	Skip automatic dependency installation	false
-y, --yes	Skip all prompts and use defaults	false

Generated Project Structure

my-celo-app/
├── apps/
│   ├── web/                 # Next.js application
│   └── contracts/           # Smart contracts (if selected)
├── packages/
│   ├── ui/                  # Shared UI components
│   └── utils/                # Shared utilities
├── package.json             # Root package.json
├── pnpm-workspace.yaml      # PNPM workspace config
├── turbo.json              # Turborepo configuration
└── tsconfig.json           # TypeScript configuration

Next Steps

After creating your project, navigate to it and install dependencies (if you didn’t use --skip-install):

cd my-celo-app
pnpm install  # If you used --skip-install
pnpm dev      # Start development server

Your project is automatically initialized with Git and includes an initial commit.

Tech Stack

Generated Projects Include:

• Next.js 14+ with App Router
• TypeScript
• Tailwind CSS
• shadcn/ui components
• Turborepo for monorepo management
• PNPM workspaces

Support

Join the Celo Discord server. Reach out in the #build-with-celo channel with your questions and feedback.

Resources

• GitHub Repository