{"id":13705800,"url":"https://github.com/celo-org/celo-composer","last_synced_at":"2025-05-15T17:05:58.798Z","repository":{"id":37009535,"uuid":"457097440","full_name":"celo-org/celo-composer","owner":"celo-org","description":"celo-composer is a starter project with all code needed to build, deploy, and upgrade a dapps on Celo.","archived":false,"fork":false,"pushed_at":"2025-05-13T23:57:25.000Z","size":13629,"stargazers_count":143,"open_issues_count":5,"forks_count":138,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-05-14T01:58:23.263Z","etag":null,"topics":["angular","blockchain","dapp","flutter","react","react-native","web3"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/celo-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-08T20:44:53.000Z","updated_at":"2025-05-06T13:52:26.000Z","dependencies_parsed_at":"2023-10-03T12:46:32.983Z","dependency_job_id":"9e61c56b-d486-40d4-a2ff-14102d57cb90","html_url":"https://github.com/celo-org/celo-composer","commit_stats":{"total_commits":364,"total_committers":35,"mean_commits":10.4,"dds":0.6016483516483517,"last_synced_commit":"5297cb95d6eec1aa0cdd6dad828eeab3db3d56ec"},"previous_names":[],"tags_count":3,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celo-org%2Fcelo-composer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celo-org%2Fcelo-composer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celo-org%2Fcelo-composer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/celo-org%2Fcelo-composer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/celo-org","download_url":"https://codeload.github.com/celo-org/celo-composer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254384988,"owners_count":22062422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","blockchain","dapp","flutter","react","react-native","web3"],"created_at":"2024-08-02T22:00:48.189Z","updated_at":"2025-05-15T17:05:53.789Z","avatar_url":"https://github.com/celo-org.png","language":"TypeScript","funding_links":[],"categories":["Build on Celo"],"sub_categories":[],"readme":"\u003c!-- TITLE --\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"100px\" src=\"https://github.com/celo-org/celo-composer/blob/main/images/readme/celo_isotype.svg\" align=\"center\" alt=\"Celo\" /\u003e\n \u003ch2 align=\"center\"\u003eCelo Composer\u003c/h2\u003e\n \u003cp align=\"center\"\u003eBuild, deploy, and iterate quickly on decentralized applications using Celo.\u003c/p\u003e\n\u003c/p\u003e\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/celo-org/celo-composer/graphs/stars\"\u003e\n      \u003cimg alt=\"GitHub Contributors\" src=\"https://img.shields.io/github/stars/celo-org/celo-composer?color=FCFF52\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/celo-org/celo-composer/graphs/contributors\"\u003e\n      \u003cimg alt=\"GitHub Contributors\" src=\"https://img.shields.io/github/contributors/celo-org/celo-composer?color=E7E3D4\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/celo-org/celo-composer/issues\"\u003e\n      \u003cimg alt=\"Issues\" src=\"https://img.shields.io/github/issues/celo-org/celo-composer?color=E7E3D4\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/celo-org/celo-composer/pulls\"\u003e\n      \u003cimg alt=\"GitHub pull requests\" src=\"https://img.shields.io/github/issues-pr/celo-org/celo-composer?color=E7E3D4\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://opensource.org/license/mit/\"\u003e\n      \u003cimg alt=\"MIT License\" src=\"https://img.shields.io/badge/License-MIT-yellow.svg\" /\u003e\n    \u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\n\u003cdiv\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\u003c/li\u003e\n      \u003col\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n     \u003c/ol\u003e\n    \u003cli\u003e\u003ca href=\"#how-to-use-celo-composer\"\u003eHow to use Celo Composer\u003c/a\u003e\u003c/li\u003e\n        \u003col\u003e\n          \u003cli\u003e\u003ca href=\"#install-dependencies\"\u003eInstall Dependencies\u003c/a\u003e\u003c/li\u003e\n          \u003cli\u003e\u003ca href=\"#deploy-a-smart-contract\"\u003eDeploy a Smart Contract\u003c/a\u003e\u003c/li\u003e\n          \u003cli\u003e\u003ca href=\"#deploy-your-dapp-locally\"\u003eDeploy your Dapp Locally\u003c/a\u003e\u003c/li\u003e\n          \u003cli\u003e\u003ca href=\"#add-ui-components\"\u003eAdd UI Components\u003c/a\u003e\u003c/li\u003e\n          \u003cli\u003e\u003ca href=\"#deploy-with-vercel\"\u003eDeploy with Vercel\u003c/a\u003e\u003c/li\u003e\n          \u003cli\u003e\u003ca href=\"#supported-frameworks\"\u003eSupported Frameworks\u003c/a\u003e\u003c/li\u003e\n          \u003cli\u003e\u003ca href=\"#supported-templates\"\u003eSupported Templates\u003c/a\u003e\u003c/li\u003e\n        \u003c/ol\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#support\"\u003eSupport\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/div\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n\nCelo Composer allows you to quickly build, deploy, and iterate on decentralized applications using Celo. It provides a number of frameworks, templates, deployment and component support, and Celo specific functionality to help you get started with your next dApp. \n\nIt is the perfect lightweight starter-kit for any hackathon and for quickly testing out integrations and deployments on Celo.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Built With\n\nCelo Composer is built on Celo to make it simple to build dApps using a variety of front-end frameworks, and libraries.\n\n- [Celo](https://celo.org/)\n- [Solidity](https://docs.soliditylang.org/en/v0.8.19/)\n- [Hardhat](https://hardhat.org/)\n- [React.js](https://reactjs.org/)\n- [Next.js](https://nextjs.org/)\n- [viem](https://viem.sh/)\n- [Tailwind](https://tailwindcss.com/)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Prerequisites\n\n- Node (v20 or higher)\n- Git (v2.38 or higher)\n\n## How to use Celo Composer\n\nThe easiest way to start with Celo Composer is using `@celo/celo-composer`. This CLI tool lets you quickly start building dApps on Celo, including several templates. To get started, just run the following command, and follow the steps:\n\n- Step 1\n\n```bash\nnpx @celo/celo-composer@latest create\n```\n\n- Step 2: Provide the Project Name: You will be prompted to enter the name of your project.\n\n```text\nWhat is your project name: \n```\n\n- Step 3: Choose to Use Hardhat: You will be asked if you want to use Hardhat. Select Yes or No.\n\n```text\nDo you want to use Hardhat? (Y/n)\n```\n\n- Step 4: Choose to Use a Template: You will be asked if you want to use a template. Select `Yes` or `No`.\n\n```text\nDo you want to use a template?\n```\n\n- Step 5: Select a Template: If you chose to use a template, you will be prompted to select a template from the list provided.\n\n```text\n- Minipay\n- Valora\n```\n\n- Step 6: Provide the Project Owner's Name: You will be asked to enter the project owner's name.\n\n```text\nProject Owner name:\n```\n\n- Step 7: Wait for Project Creation: The CLI will now create the project based on your inputs. This may take a few minutes.\n\n- Step 8: Follow the instructions to start the project. The same will be displayed on the console after the project is created.\n\n```text\n🚀 Your starter project has been successfully created!\n```\n\n## Install Dependencies\n\n\nOnce your custom dApp has been created, just install dependencies, either with yarn:\n\n```bash\n   yarn\n```\n\nIf you prefer npm, you can run:\n\n```bash\n   npm install\n```\n\n## Deploy a Smart Contract\n\nFind the detailed instructions on how to run your smart contract in [packages/hardhat/README.md](./packages/hardhat/README.md).\n\nFor quick development follow these three steps:\n\n1. Change `packages/hardhat/env.template` to `packages/hardhat/env` and add your `PRIVATE_KEY` into the `.env` file.\n2. Make sure your wallet is funded when deploying to testnet or mainnet. You can get test tokens for deploying it on Alfajores from the [Celo Faucet](https://faucet.celo.org/alfajores).\n3. Run the following commands from the `packages/hardhat` folder to deploy your smart contract to the Celo Testnet Alfajores:\n\n```bash\nnpx hardhat ignition deploy ./ignition/modules/Lock.ts --network alfajores\n```\n\n## Deploy your Dapp Locally\n\nFind the detailed instructions on how to run your frontend in the [`react-dapp` README.md](./packages/react-app/README.md).\n\nBefore you start the project, please follow these steps:\n\n1. Rename the file:\n   packages/react-app/.env.template\n   to\n   packages/react-app/.env\n\n2. Open the newly renamed .env file and add your WalletConnect Cloud Project ID from [WalletConnect Cloud](https://cloud.walletconnect.com/)\n\nOnce you've done that, you're all set to start your project!\n\nRun the following commands from the `packages/react-app` folder to start the project:\n\n```bash\n   yarn dev\n```\n\nIf you prefer npm, you can run:\n\n```bash\n   npm run dev\n```\n\nThank you for using Celo Composer! If you have any questions or need further assistance, please refer to the README or reach out to our team.\n\n**_🔥Voila, you have a dApp ready to go. Start building your dApp on Celo._**\n\n\n## Add UI Components\n\nTo keep the Celo Composer as lightwieght as possible we didn't add any components but rather a guide on how to add the components you need yourself with a very simple to use components library. To learn how to add UI components using [ShadCN](https://ui.shadcn.com/) in this project, refer to the [UI Components Guide](./docs/UI_COMPONENTS.md).\n\n## Deploy with Vercel\n\nThe Celo Composer is a great tool for hackathons and fast deployments. We created a guide for you, using the Vercel CLI to create a live deployment in minutes. For detailed instructions on deploying the Next.js app using Vercel CLI, refer to the [Deployment Guide](./docs/DEPLOYMENT_GUIDE.md).\n\n\n## Supported Frameworks\n\n### React / Nextjs\n\n- Support for Website and Progressive Web Application.\n- Works with all major crypto wallets.\n\nCheck [nextjs docs](https://nextjs.org/docs) to learn more about it.\n\n### Hardhat\n\n- Robust framework for building and testing smart contracts.\n- Compatible with various Ethereum development tools and plugins.\n\nCheck [hardhat docs](https://hardhat.org/hardhat-runner/docs/getting-started) to learn more about it.\n\n## Supported Templates\n\n### Minipay\n\n- Pre-built template for creating a mini-payment application.\n- Seamless integration with Celo blockchain for handling payments.\n\nCheckout [minipay docs](https://docs.celo.org/developer/build-on-minipay/overview) to learn more about it.\n\n### Valora\n\n- Template designed for Valora wallet integration.\n- Facilitates easy wallet connectivity and transaction management.\n\nCheckout [valora docs](https://docs.valora.xyz/) to learn more about it.\n\n\n## Support\n\nJoin the Celo Discord server at \u003chttps://chat.celo.org\u003e. Reach out on the dedicated repo channel [here](https://discord.com/channels/600834479145353243/941003424298856448).\n\n\u003c!-- ROADMAP --\u003e\n\n## Roadmap\n\nSee the [open issues](https://github.com/celo-org/celo-composer/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## Contributing\n\nWe welcome contributions from the community.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## License\n\nDistributed under the MIT License. See `LICENSE.txt` for more information.\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\n- [@CeloDevs](https://twitter.com/CeloDevs)\n- [Discord](https://discord.com/invite/celo)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcelo-org%2Fcelo-composer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcelo-org%2Fcelo-composer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcelo-org%2Fcelo-composer/lists"}