Skip to main content

README

Table of Contents

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.

(back to top)

Getting Started​

To build your dApp, you'll need to install the dependencies, create a new project, and run the following commands:

Prerequisites​

  • Node

How to use Celo Composer​

The easiest way to get started with Celo Composer is using @celo/celo-composer. This is a CLI tool enables you to quickly start building dApps on Celo for multiple frameworks including React, React Native (w/o Expo), Flutter and Angular. You can create the dApp using default Composer templates provided by Celo. To get started, use the following command:

npx @celo/celo-composer create

This will prompt you to select the framework and the template you want to use​

Celo Composer select framework

Once you select the framework and the template, it will ask you to select the smart contract development environment tool​

Celo Composer tool selection

After selecting the tool, it will ask you whether you want subgraph support for your dApp​

Celo Composer subgraph support

Finally, it will ask you for the name of your dApp​

Celo Composer dApp name

🔥Voila, you have your dApp ready to go. You can now start building your dApp on Celo.

Supported Frameworks​

React​

  • Creating examples and experiment with React for your libraries and components.
  • Start the dApp with yarn dev/npm run dev and you are good to go.
  • Support for Website and Progressive Web Application.
  • Works with all major crypto wallet.

Check here to learn more about Celo Composer - React

React Native​

  • You don't need to configure anything. A reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.
  • Support for Android and IOS.
  • Works with Expo and without Expo.
  • Working example app - The included example app shows how this all works together.
  • Easy to use and always updated with latest dependencies.

Check here to learn more about Celo Composer - React Native

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 - The included example app shows how this all works together.
  • Easy to use and always updated with latest dependencies.

Check here to learn more about Celo Composer - Flutter

Angular​

  • Creating examples and experiment with Angular for your libraries and components.
  • Easy to setup and use.

Check here to learn more about Celo Composer - Angular

🔭 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​

As a contributor, you can add your own dApp to this repository and include it as a tab for others to access. Follow the steps below and reference existing files for additional details to help you get started.

If you decide to try this out and find something confusing, consider opening an pull request to make things more clear for the next developer that comes through. If you improve the user interface or create new components that you think might be useful for other developers, consider opening a PR.

We will happily compensate you for contributions. Anywhere between 5 and 50 cUSD (or more) depending on the work. This is dependent on the work that is done and is ultimately up to the discretion of the Celo Foundation developer relations team.

You can view the associated bounty on Gitcoin here.

(back to top)

License​

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

Contact​

(back to top)