Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/celo-org/celo-composer

celo-composer is a starter project with all code needed to build, deploy, and upgrade a dapps on Celo.
https://github.com/celo-org/celo-composer

angular blockchain dapp flutter react react-native web3

Last synced: 15 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/celo-org/celo-composer
Owner: celo-org
License: mit
Created: 2022-02-08T20:44:53.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-06-09T08:40:28.000Z (28 days ago)
Last Synced: 2024-06-09T09:45:37.106Z (28 days ago)
Topics: angular, blockchain, dapp, flutter, react, react-native, web3
Language: TypeScript
Homepage:
Size: 13 MB
Stars: 112
Watchers: 9
Forks: 100
Open Issues: 51
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-celo - Celo Composer

README

        
 

  

 
Celo Composer

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


  


    

      

    

    

      

    

    

      

    

    

      

    

    

      

    

  


  Table of Contents

  


    

      About The Project

      

        Built With

      

    

    

      

        Prerequisites

        Installation

      

    

    Usage

    Roadmap

    Contributing

    License

    Contact

    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.

- [Celo](https://celo.org/)

- [Solidity](https://docs.soliditylang.org/en/v0.8.19/)

- [Next.js](https://nextjs.org/)

- [React.js](https://reactjs.org/)

- [Material UI](https://mui.com/)

- [React Native](https://reactnative.dev/)

- [Flutter](https://docs.flutter.dev/)

- [React-celo](https://github.com/celo-org/react-celo/)

- [Rainbowkit-celo](https://github.com/celo-org/rainbowkit-celo)

(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:

```bash

npx @celo/celo-composer@latest create

```

### Front-end framework

![Celo Composer select framework](https://github.com/celo-org/celo-composer/blob/main/images/readme/cc_step_1.png?raw=true)

### Web3 library (for react-app)

![Celo Composer select framework](https://github.com/celo-org/celo-composer/blob/main/images/readme/cc_step_2.png?raw=true)

### Smart contract framework

![Celo Composer tool selection](https://github.com/celo-org/celo-composer/blob/main/images/readme/cc_step_3.png?raw=true)

### Subgraph

![Celo Composer subgraph support](https://github.com/celo-org/celo-composer/blob/main/images/readme/cc_step_4.png?raw=true)

### Name your dApp

![Celo Composer dApp name](https://github.com/celo-org/celo-composer/blob/main/images/readme/cc_step_5.png?raw=true)

**_🔥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](https://github.com/celo-org/celo-composer/blob/main/packages/react-app/README.md) 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](https://expo.dev/).

- Working example app included.

Check [package readme](https://github.com/celo-org/celo-composer/blob/main/packages/react-native-app/README.md) 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](https://github.com/celo-org/celo-composer/blob/main/packages/flutter-app/README.md) to learn more about.

### Angular

- Support for Website and Progressive Web Application.

- Works with all major crypto wallets.

Check [package readme](https://github.com/celo-org/celo-composer/blob/main/packages/angular-app/README.md) to learn more about.

## 🔭 Learning Solidity

📕 Read the docs: 

- [Primitive Data Types](https://solidity-by-example.org/primitives/)

- [Mappings](https://solidity-by-example.org/mapping/)

- [Structs](https://solidity-by-example.org/structs/)

- [Modifiers](https://solidity-by-example.org/function-modifier/)

- [Events](https://solidity-by-example.org/events/)

- [Inheritance](https://solidity-by-example.org/inheritance/)

- [Payable](https://solidity-by-example.org/payable/)

- [Fallback](https://solidity-by-example.org/fallback/)

📧 Learn the [Solidity globals and units](https://solidity.readthedocs.io/en/v0.8.19/units-and-global-variables.html)

## Support

Join the Celo Discord server at . Reach out on the dedicated repo channel [here](https://discord.com/channels/600834479145353243/941003424298856448).

## Roadmap

See the [open issues](https://github.com/celo-org/celo-composer/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

- [@CeloDevs](https://twitter.com/CeloDevs)

- [Discord](https://discord.com/invite/celo)

(back to top)