/celo-composer

celo-composer is a starter project with all code needed to build, deploy, and upgrade a dapps on Celo.

Primary LanguageTypeScriptMIT LicenseMIT

Celo

Celo Composer

Build, deploy, and iterate quickly on decentralized applications using Celo.

GitHub Contributors GitHub Contributors Issues GitHub pull requests MIT License

Table of Contents
  1. About The Project
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Celo Composer allows you to quickly build, deploy, and iterate on decentralized applications using Celo. It provides a number of frameworks, examples, and Celo specific functionality to help you get started with your next dApp.

(back to top)

Built With

Celo Composer is built on Celo to make it simple to build dApps using a variety of front-end frameworks, and libraries.

(back to top)

Prerequisites

  • Node
  • Git (v2.38 or higher)

How to use Celo Composer

The easiest way to start with Celo Composer is using @celo/celo-composer. This CLI tool lets you quickly start building dApps on Celo for multiple frameworks, including React (with either react-celo or rainbowkit-celo), React Native (w/o Expo), Flutter, and Angular. To get started, just run the following command, and follow the steps:

npx @celo/celo-composer@latest create

Front-end framework

Celo Composer select framework

Web3 library (for react-app)

Celo Composer select framework

Smart contract framework

Celo Composer tool selection

Subgraph

Celo Composer subgraph support

Name your dApp

Celo Composer dApp name

🔥Voila, you have a dApp ready to go. Voila, you have a dApp ready to go. Start building your dApp on Celo.

Getting started

Once your custom dApp has been created, just install dependencies, either with yarn or npm i, and run the respective script from the package.json file.

Supported Frameworks

React

  • Support for Website and Progressive Web Application.
  • Works with all major crypto wallets.

Check package readme to learn more about.

React Native

  • Out of the box config, just focus on buidl.
  • Support for Android and IOS.
  • Works with and without Expo.
  • Working example app included.

Check package readme to learn more about.

Flutter

  • One command to get started - Type flutter run to start development in your mobile phone.
  • Works with all major mobile crypto wallets.
  • Support for Android, IOS (Web, Windows, and Linux coming soon).
  • Working example app included.

Check package readme to learn more about.

Angular

  • Support for Website and Progressive Web Application.
  • Works with all major crypto wallets.

Check package readme to learn more about.

🔭 Learning Solidity

📕 Read the docs: https://docs.soliditylang.org

📧 Learn the Solidity globals and units

Support

Join the Celo Discord server at https://chat.celo.org. Reach out on the dedicated repo channel here.

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

We welcome contributions from the community.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

(back to top)