@celo/celo-composer NPM

About The Project

Celo Composer allows you to quickly build, deploy, and iterate on decentralized applications using Celo. It provides a variety of frameworks, templates, deployment tools, UI components, and Celo-specific functionality to accelerate your dApp development.

This is an ideal lightweight starter-kit for hackathons and rapid prototyping on Celo.

Built With

Celo Composer is built on the Celo ecosystem and supports multiple frameworks and libraries:

Prerequisites

Ensure you have the following installed:

Node.js (v20 or higher)
Git (v2.38 or higher)

How to use Celo Composer

The easiest way to start is by using the @celo/celo-composer CLI tool. It helps bootstrap dApps with different templates.

Interactive Mode (Recommended)

Run the CLI tool and follow the interactive prompts:

npx @celo/celo-composer@latest create

Inline Commands Mode

For automation or CI/CD pipelines, you can also use inline commands with flags:

# Basic usage with all options
npx @celo/celo-composer@latest create --name my-celo-app --owner "John Doe" --hardhat --template Minipay

# Short flags version
npx @celo/celo-composer@latest create -n my-app -o "Jane Smith" --no-hardhat -t Valora

# Only specify some options (remaining will be prompted)
npx @celo/celo-composer@latest create --name my-project --hardhat

Available Flags:

--name, -n: Name of the project (will be converted to kebab-case)
--owner, -o: Project owner name
--hardhat: Include Hardhat in the project
--no-hardhat: Exclude Hardhat from the project
--template, -t: Template to use (Minipay, Valora, or Social Connect)

Installation Steps

Enter a project name (or use --name flag)
Choose whether to use Hardhat (or use --hardhat/--no-hardhat flags)
Select a template (or use --template flag)
Provide project owner details (or use --owner flag)
Wait for project creation to complete
Follow the on-screen instructions to start your project

Install Dependencies

Once the project is set up, install dependencies:

yarn
# or
npm install

Deploy a Smart Contract

For detailed instructions, refer to packages/hardhat/README.md.

Quick steps:

Rename packages/hardhat/.env.template to packages/hardhat/.env and add your PRIVATE_KEY.
Ensure your wallet has test funds from the Celo Faucet.
Deploy the contract:

npx hardhat ignition deploy ./ignition/modules/Lock.ts --network alfajores

Deploy Your Dapp Locally

Before starting your project, follow these steps:

Rename .env.template to .env in packages/react-app/.
Add your WalletConnect Project ID from WalletConnect Cloud.

Start the local server:

yarn dev
# or
npm run dev

Add UI Components

To keep Celo Composer lightweight, UI components are not pre-installed. You can easily add components using ShadCN. Refer to the UI Components Guide for details.