From d57e30f594d07afa398978de64399f09856cf890 Mon Sep 17 00:00:00 2001 From: sergeypanin1994 Date: Tue, 18 Feb 2025 21:22:12 +0300 Subject: [PATCH 1/5] fix: update Twitter URL to x.com format Updated the Twitter URL from https://twitter.com to https://x.com to reflect the platform's rebranding. --- README.md | 2 +- packages/react-app/components/Footer.tsx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96e6062..6b9b2e0 100644 --- a/README.md +++ b/README.md @@ -262,7 +262,7 @@ Distributed under the MIT License. See `LICENSE.txt` for more information. ## Contact -- [@CeloDevs](https://twitter.com/CeloDevs) +- [@CeloDevs](https://x.com/CeloDevs) - [Discord](https://discord.com/invite/celo)

(back to top)

diff --git a/packages/react-app/components/Footer.tsx b/packages/react-app/components/Footer.tsx index f365238..9561586 100644 --- a/packages/react-app/components/Footer.tsx +++ b/packages/react-app/components/Footer.tsx @@ -5,7 +5,7 @@ type Props = { const navigation = [ { name: 'Twitter', - href: 'https://twitter.com/CeloDevs', + href: 'https://x.com/CeloDevs', icon: (props: Props) => ( From bf8f949cdafa8616c22e84d29a80fde7ad93a2bb Mon Sep 17 00:00:00 2001 From: sergeypanin1994 Date: Tue, 18 Feb 2025 21:25:14 +0300 Subject: [PATCH 2/5] chore: improved contact links formatting and consistency - Renamed "Check Docs" to "Documentation" for clarity - Improved wording for better readability and user guidance - Ensured consistent punctuation across descriptions --- .github/ISSUE_TEMPLATE/bug_report.yaml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index e785cbd..5aaf125 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -7,11 +7,11 @@ body: value: | ## Thanks for taking the time to fill out this bug report! - We're sorry that your experiencing an issue. So that we can help you efficiently, please fill in this form to the best of your ability. The more information that you can provide the easier we will be able to help you. + We're sorry that you're experiencing an issue. To help us assist you efficiently, please fill out this form to the best of your ability. The more details you provide, the easier it will be for us to resolve the issue. - type: dropdown attributes: - label: Which Framework? - description: Select all the framework that you are facing issues with. + label: Which framework are you using? + description: Select all the frameworks where you are experiencing issues. multiple: true options: - "React" @@ -28,19 +28,19 @@ body: - type: textarea attributes: label: What happened? - description: Also tell us, what did you expect to happen? + description: Describe the issue and what you expected to happen. placeholder: Tell us what you see! - type: textarea attributes: label: Steps to reproduce - description: Please could you provide clearly ordered steps to reproduce the issue. + description: Please provide clearly ordered steps to reproduce the issue. placeholder: | - 1. Login to the System - 2. Click the Menu Item + 1. Log in to the system + 2. Click the menu item 3. Submit - type: textarea attributes: label: Anything else? description: | - Links? References? Anything that will give us more context about the issue you are encountering! + Links? References? Any additional context about the issue you are encountering? Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. From 0468983ca603597bd7ea88b43ce728a99aef36c0 Mon Sep 17 00:00:00 2001 From: sergeypanin1994 Date: Tue, 18 Feb 2025 21:29:04 +0300 Subject: [PATCH 3/5] docs: improved deployment guide for Celo Composer - Fixed typos and improved readability - Standardized formatting for better clarity - Enhanced step descriptions for a smoother deployment experience --- .github/ISSUE_TEMPLATE/config.yml | 6 +++--- .github/ISSUE_TEMPLATE/feature_request.yaml | 14 +++++++------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 200569c..c87bc3b 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,7 +2,7 @@ blank_issues_enabled: false contact_links: - name: Discussions url: https://github.com/celo-org/celo-composer/discussions - about: General discussions about Celo Composer - - name: Check Docs + about: General discussions about Celo Composer. + - name: Documentation url: https://docs.celo.org/ - about: If you need help with your first steps of Celo Composer, check out the docs! + about: Need help getting started with Celo Composer? Check out the official docs! diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 53a3bfc..f58e42f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,22 +1,22 @@ name: Feature Request -description: File a feature request +description: Submit a feature request title: "[Feature]: " body: - type: markdown attributes: value: | - ## Thanks for taking the time to fill out this feature request! + ## Thanks for taking the time to submit this feature request! - We love to hear any and all ideas that you may have. It would be great to get as much detail from you as you wish to provide. + We appreciate all ideas and suggestions. The more details you provide, the better we can understand and evaluate your request. - type: textarea attributes: - label: Tell us about your idea + label: Describe your idea description: | - - Give as much detail as you can to help us understand the change you want to see. - - What is the expected outcome? + - Provide as much detail as possible to help us understand the change you’d like to see. + - What is the expected outcome or benefit? - type: textarea attributes: label: Anything else? description: | - Links? References? Anything that will give us more context. + Links? References? Any additional context that can help us understand your request. Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. From 87dbb7dd2f5a781cd8090ebcae4365001beeb2a0 Mon Sep 17 00:00:00 2001 From: sergeypanin1994 Date: Tue, 18 Feb 2025 21:32:41 +0300 Subject: [PATCH 4/5] docs: improved UI components guide for Celo Composer - Fixed typos and improved readability - Standardized formatting for clarity - Enhanced step descriptions for a smoother setup experience docs: improved deployment guide for Celo Composer - Fixed typos and improved readability - Standardized formatting for better clarity - Enhanced step descriptions for a smoother deployment experience --- docs/DEPLOYMENT_GUIDE.md | 96 +++++++++++++++++++++------------------- docs/UI_COMPONENTS.md | 59 ++++++++++++------------ 2 files changed, 78 insertions(+), 77 deletions(-) diff --git a/docs/DEPLOYMENT_GUIDE.md b/docs/DEPLOYMENT_GUIDE.md index ece465f..b00446f 100644 --- a/docs/DEPLOYMENT_GUIDE.md +++ b/docs/DEPLOYMENT_GUIDE.md @@ -1,95 +1,99 @@ -# Deployment Guide for Celo Composer React/Next App Using Vercel CLI +# **Deployment Guide for Celo Composer React/Next.js App Using Vercel CLI** -This document provides step-by-step instructions for deploying your Next.js app to Vercel using the Vercel CLI. +This document provides step-by-step instructions for deploying your Next.js app to Vercel using the Vercel CLI. -## Prerequisites +## **Prerequisites** -1. **Node.js installed**: Ensure Node.js is installed on your system. +1. **Node.js installed**: Ensure that Node.js is installed on your system. -## Step 1: Install Vercel CLI +## **Step 1: Install Vercel CLI** -Install Vercel CLI globally using npm or pnpm: +Install the Vercel CLI globally using npm or pnpm: ```bash npm install -g vercel # OR if using pnpm pnpm add -g vercel -``` +``` -## Step 2: Login to Vercel +## **Step 2: Log in to Vercel** -Log in to your Vercel account: +Log in to your Vercel account: ```bash vercel login -``` +``` -Follow the on-screen instructions to authenticate your account. +Follow the on-screen instructions to authenticate your account. -## Step 3: Goto React App +## **Step 3: Navigate to the React App Directory** -Navigate to the root directory of your Next.js app: +Move to the root directory of your Next.js app: ```bash cd packages/react-app -``` +``` -## Step 4: Deploy the App +## **Step 4: Deploy the App** -To deploy your Celo Composer app using Vercel CLI, run: +To deploy your Celo Composer app using the Vercel CLI, run: ```bash vercel -``` +``` -> [!NOTE] -> First-Time Deployment: -> -> - The CLI will ask several questions, including project scope, project name, and framework detection. -> -> Subsequent Deployments: -> -> - Run vercel to deploy the latest changes without additional configuration. +> **Note:** +> **First-Time Deployment:** +> - The CLI will ask several questions, including project scope, project name, and framework detection. +> +> **Subsequent Deployments:** +> - Run `vercel` to deploy the latest changes without additional configuration. -## Step 5: View Deployment Status +## **Step 5: View Deployment Status** -After deployment, you’ll receive a preview deployment URL: +After deployment, you’ll receive a preview deployment URL: ```bash https://.vercel.app -``` +``` -> [!IMPORTANT] -> Important: This preview deployment is only accessible to the authenticated user (the Vercel account owner). To make your app publicly accessible, you need to deploy to production. +> **Important:** +> This preview deployment is only accessible to the authenticated user (the Vercel account owner). To make your app publicly accessible, you need to deploy it to production. -## Step 6: Deploy to Production +## **Step 6: Deploy to Production** -To make the app publicly accessible, deploy it to production: +To make the app publicly accessible, deploy it to production: ```bash vercel deploy --prod -``` +``` -This command creates a production deployment accessible to everyone. +This command creates a production deployment that is accessible to everyone. -## Step 8: Configure Environment Variables +## **Step 7: Configure Environment Variables** -If your app uses environment variables, configure them in Vercel: +If your app uses environment variables, configure them in Vercel: -1. Go to the Vercel Dashboard. -2. Select your project. -3. Go to Settings > Environment Variables. -4. Add variables for Development, Preview, and Production environments. +1. Go to the **Vercel Dashboard**. +2. Select your project. +3. Navigate to **Settings > Environment Variables**. +4. Add variables for Development, Preview, and Production environments. -Alternatively, use Vercel CLI: +Alternatively, you can set environment variables using the Vercel CLI: ```bash vercel env add -``` +``` -## Step 9: Update Deployment +## **Step 8: Update Deployment** -Whenever you make changes to your code, update the deployment: +Whenever you make changes to your code, update the deployment: -- Preview deployment: `vercel` -- Production deployment: `vercel --prod` +- **For a preview deployment:** + ```bash + vercel + ``` +- **For a production deployment:** + ```bash + vercel --prod + ``` \ No newline at end of file diff --git a/docs/UI_COMPONENTS.md b/docs/UI_COMPONENTS.md index 2b27a90..20f5fb2 100644 --- a/docs/UI_COMPONENTS.md +++ b/docs/UI_COMPONENTS.md @@ -1,73 +1,70 @@ -# Adding UI Components to Your Next.js App +# **Adding UI Components to Your Next.js App** -This guide explains how to add UI components to your Next.js app using [ShadCN](https://ui.shadcn.com/), a component library that provides a set of pre-built, easy-to-use components. We will demonstrate the installation of ShadCN and provide an example of adding and using a button component. +This guide explains how to add UI components to your Next.js app using [ShadCN](https://ui.shadcn.com/), a component library that provides a set of pre-built, easy-to-use components. We will demonstrate the installation of ShadCN and provide an example of adding and using a button component. -## Step 1: Initialize ShadCN in Your Project +## **Step 1: Initialize ShadCN in Your Project** -To get started, install the ShadCN CLI globally: +To get started, install the ShadCN CLI and initialize it in your project: ```bash cd packages/react-app npx shadcn@latest init -d -``` +``` -This command initializes ShadCN and adds its configuration to your project. +This command initializes ShadCN and adds its configuration to your project. -## Step 3: Install the Button Component +## **Step 2: Install the Button Component** -[ShadCN](https://ui.shadcn.com/) provides a variety of components, including buttons, inputs, cards, and [more](https://ui.shadcn.com/). To install the button component, use: +[ShadCN](https://ui.shadcn.com/) provides a variety of components, including buttons, inputs, cards, and [more](https://ui.shadcn.com/). To install the button component, use: ```bash -# add a button component - +# Add a button component npx shadcn add button -``` +``` -This command adds the button component to your project’s components folder, making it available for use. +This command adds the button component to your project’s `components/ui/` folder, making it available for use. -## Step 4: Import and Use the Button Component +## **Step 3: Import and Use the Button Component** -Once the button component is installed, you can import and use it in your app. +Once the button component is installed, you can import and use it in your app. -Open `app/page.tsx` and modify it as follows: +Open `app/page.tsx` and modify it as follows: ```tsx import { Button } from '@/components/ui/button'; - export default function Home() { - // ... some functions - // Function to handle button click const handleClick = () => { - // add an action - console.log('I love the Celo Composer <3') + console.log('I love the Celo Composer ❤️'); }; return ( - // ... some components
- ); } -``` +``` + +This will render a button at the center of the page. -This will render a button at the center of the page. +## **Step 4: Additional Information** -## Additional Information +### **Customizing the Button** +You can customize the button’s styles in the generated [`components/ui/button.tsx`](../packages/react-app/components/ui/button.tsx) file. -- Customizing the Button: You can customize the button’s styles in the generated [`components/ui/button.tsx`](../packages/react-app/components/ui/button.tsx) file. -- Installing Other Components: ShadCN offers a wide range of components, such as cards, inputs, and more. For example, to add the card or input component you can, use: +### **Installing Other Components** +ShadCN offers a wide range of components, such as cards, inputs, and more. To add other components, use: ```bash -# add a card component +# Add a card component npx shadcn add card -# add a input component +# Add an input component npx shadcn add input -``` +``` -- Documentation: For more components and advanced usage, refer to [ShadCN documentation](https://ui.shadcn.com/docs). +### **Documentation** +For more components and advanced usage, refer to the [ShadCN documentation](https://ui.shadcn.com/docs). \ No newline at end of file From e2d2053e1cc95f82331cbe95ea8aca3168443e71 Mon Sep 17 00:00:00 2001 From: sergeypanin1994 Date: Tue, 18 Feb 2025 21:36:42 +0300 Subject: [PATCH 5/5] docs: improved README formatting and clarity - Fixed typos and improved consistency - Standardized formatting for better readability - Updated outdated links and enhanced descriptions --- README.md | 316 +++++++++++++++++++++--------------------------------- 1 file changed, 123 insertions(+), 193 deletions(-) diff --git a/README.md b/README.md index 6b9b2e0..24a94b0 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@

Celo -

Celo Composer

-

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

+

Celo Composer

+

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

-

- - GitHub Contributors + +

+ + GitHub Stars GitHub Contributors @@ -15,254 +16,183 @@ Issues - GitHub pull requests + GitHub Pull Requests MIT License -

- - -
- Table of Contents -
    -
  1. About The Project
    2. -
      -
    1. Built With
      2. -
    2. Prerequisites
      3. -
    -
  2. How to use Celo Composer
    3. -
      -
    1. Install Dependencies
      2. -
    2. Deploy a Smart Contract
      3. -
    3. Deploy your Dapp Locally
      4. -
    4. Add UI Components
      5. -
    5. Deploy with Vercel
      6. -
    6. Supported Frameworks
      7. -
    7. Supported Templates
      8. -
    -
  3. Usage
    4. -
  4. Support
    5. -
  5. Roadmap
    6. -
  6. Contributing
    7. -
  7. License
    8. -
  8. Contact
    9. -
-
- - - -## About The Project - -Celo 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. - -It is the perfect lightweight starter-kit for any hackathon and for quickly testing out integrations and deployments on Celo. - -

(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/) -- [Hardhat](https://hardhat.org/) -- [React.js](https://reactjs.org/) -- [Next.js](https://nextjs.org/) -- [viem](https://viem.sh/) -- [Tailwind](https://tailwindcss.com/) - -

(back to top)

- - - -## Prerequisites - -- Node (v20 or higher) -- Git (v2.38 or higher) +--- -## How to use Celo Composer +## **Table of Contents** +1. [About The Project](#about-the-project) + - [Built With](#built-with) + - [Prerequisites](#prerequisites) +2. [How to use Celo Composer](#how-to-use-celo-composer) + - [Install Dependencies](#install-dependencies) + - [Deploy a Smart Contract](#deploy-a-smart-contract) + - [Deploy Your Dapp Locally](#deploy-your-dapp-locally) + - [Add UI Components](#add-ui-components) + - [Deploy with Vercel](#deploy-with-vercel) + - [Supported Frameworks](#supported-frameworks) + - [Supported Templates](#supported-templates) +3. [Usage](#usage) +4. [Support](#support) +5. [Roadmap](#roadmap) +6. [Contributing](#contributing) +7. [License](#license) +8. [Contact](#contact) -The 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: - -- Step 1 - -```bash -npx @celo/celo-composer@latest create -``` +--- -- Step 2: Provide the Project Name: You will be prompted to enter the name of your project. +## **About The Project** -```text -What is your project name: -``` +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. -- Step 3: Choose to Use Hardhat: You will be asked if you want to use Hardhat. Select Yes or No. +This is an ideal lightweight starter-kit for hackathons and rapid prototyping on Celo. -```text -Do you want to use Hardhat? (Y/n) -``` +--- -- Step 4: Choose to Use a Template: You will be asked if you want to use a template. Select `Yes` or `No`. +## **Built With** +Celo Composer is built on the Celo ecosystem and supports multiple frameworks and libraries: -```text -Do you want to use a template? -``` +- [Celo](https://celo.org/) +- [Solidity](https://docs.soliditylang.org/) +- [Hardhat](https://hardhat.org/) +- [React.js](https://reactjs.org/) +- [Next.js](https://nextjs.org/) +- [Viem](https://viem.sh/) +- [Tailwind CSS](https://tailwindcss.com/) -- Step 5: Select a Template: If you chose to use a template, you will be prompted to select a template from the list provided. +--- -```text -- Minipay -- Valora -``` +## **Prerequisites** +Ensure you have the following installed: -- Step 6: Provide the Project Owner's Name: You will be asked to enter the project owner's name. +- **Node.js** (v20 or higher) +- **Git** (v2.38 or higher) -```text -Project Owner name: -``` +--- -- Step 7: Wait for Project Creation: The CLI will now create the project based on your inputs. This may take a few minutes. +## **How to use Celo Composer** -- Step 8: Follow the instructions to start the project. The same will be displayed on the console after the project is created. +The easiest way to start is by using the `@celo/celo-composer` CLI tool. It helps bootstrap dApps with different templates. -```text -🚀 Your starter project has been successfully created! +```bash +npx @celo/celo-composer@latest create ``` -## Install Dependencies - +### **Installation Steps** +1. **Enter a project name** +2. **Choose whether to use Hardhat** (Yes/No) +3. **Select a template** (Minipay, Valora, etc.) +4. **Provide project owner details** +5. **Wait for project creation to complete** +6. **Follow the on-screen instructions to start your project** -Once your custom dApp has been created, just install dependencies, either with yarn: +--- -```bash - yarn -``` - -If you prefer npm, you can run: +## **Install Dependencies** +Once the project is set up, install dependencies: ```bash - npm install +yarn +# or +npm install ``` -## Deploy a Smart Contract - -Find the detailed instructions on how to run your smart contract in [packages/hardhat/README.md](./packages/hardhat/README.md). +--- -For quick development follow these three steps: +## **Deploy a Smart Contract** +For detailed instructions, refer to [`packages/hardhat/README.md`](./packages/hardhat/README.md). -1. Change `packages/hardhat/env.template` to `packages/hardhat/env` and add your `PRIVATE_KEY` into the `.env` file. -2. 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). -3. Run the following commands from the `packages/hardhat` folder to deploy your smart contract to the Celo Testnet Alfajores: +Quick steps: +1. Rename `packages/hardhat/.env.template` to `packages/hardhat/.env` and add your `PRIVATE_KEY`. +2. Ensure your wallet has test funds from the [Celo Faucet](https://faucet.celo.org/alfajores). +3. Deploy the contract: ```bash npx hardhat ignition deploy ./ignition/modules/Lock.ts --network alfajores ``` -## Deploy your Dapp Locally - -Find the detailed instructions on how to run your frontend in the [`react-dapp` README.md](./packages/react-app/README.md). - -Before you start the project, please follow these steps: - -1. Rename the file: - packages/react-app/.env.template - to - packages/react-app/.env +--- -2. Open the newly renamed .env file and add your WalletConnect Cloud Project ID from [WalletConnect Cloud](https://cloud.walletconnect.com/) +## **Deploy Your Dapp Locally** +Before starting your project, follow these steps: -Once you've done that, you're all set to start your project! +1. Rename `.env.template` to `.env` in `packages/react-app/`. +2. Add your WalletConnect Project ID from [WalletConnect Cloud](https://cloud.walletconnect.com/). -Run the following commands from the `packages/react-app` folder to start the project: +Start the local server: ```bash - yarn dev +yarn dev +# or +npm run dev ``` -If you prefer npm, you can run: - -```bash - npm run dev -``` - -Thank 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. - -**_🔥Voila, you have a dApp ready to go. Start building your dApp on Celo._** - - -## Add UI Components - -To 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). - -## Deploy with Vercel - -The 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). - - -## Supported Frameworks - -### React / Nextjs - -- Support for Website and Progressive Web Application. -- Works with all major crypto wallets. - -Check [nextjs docs](https://nextjs.org/docs) to learn more about it. - -### Hardhat - -- Robust framework for building and testing smart contracts. -- Compatible with various Ethereum development tools and plugins. - -Check [hardhat docs](https://hardhat.org/hardhat-runner/docs/getting-started) to learn more about it. - -## Supported Templates - -### Minipay - -- Pre-built template for creating a mini-payment application. -- Seamless integration with Celo blockchain for handling payments. +--- -Checkout [minipay docs](https://docs.celo.org/developer/build-on-minipay/overview) to learn more about it. +## **Add UI Components** +To keep Celo Composer lightweight, UI components are not pre-installed. You can easily add components using [ShadCN](https://ui.shadcn.com/). Refer to the [UI Components Guide](./docs/UI_COMPONENTS.md) for details. -### Valora +--- -- Template designed for Valora wallet integration. -- Facilitates easy wallet connectivity and transaction management. +## **Deploy with Vercel** +Deploying with Vercel is quick and easy. Follow our [Deployment Guide](./docs/DEPLOYMENT_GUIDE.md) for step-by-step instructions. -Checkout [valora docs](https://docs.valora.xyz/) to learn more about it. +--- +## **Supported Frameworks** +### **React / Next.js** +- Supports web and PWA applications +- Compatible with major crypto wallets +📖 [Next.js Docs](https://nextjs.org/docs) -## Support +### **Hardhat** +- Powerful tool for smart contract development +- Works with various Ethereum dev tools +📖 [Hardhat Docs](https://hardhat.org/hardhat-runner/docs/getting-started) -Join the Celo Discord server at . Reach out on the dedicated repo channel [here](https://discord.com/channels/600834479145353243/941003424298856448). +--- - +## **Supported Templates** +### **Minipay** +- Pre-configured for building a mini-payment dApp on Celo +📖 [Minipay Docs](https://docs.celo.org/developer/build-on-minipay/overview) -## Roadmap +### **Valora** +- Designed for easy Valora wallet integration +📖 [Valora Docs](https://docs.valora.xyz/) -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)

+## **Support** +Join the Celo community on Discord: +📌 [Celo Discord](https://chat.celo.org) +💬 [Repo Support Channel](https://discord.com/channels/600834479145353243/941003424298856448) - +--- -## Contributing +## **Roadmap** +See the [open issues](https://github.com/celo-org/celo-composer/issues) for upcoming features and bug tracking. -We welcome contributions from the community. +--- -

(back to top)

+## **Contributing** +We welcome community contributions! +Please refer to our [contribution guidelines](./CONTRIBUTING.md) to get started. -## License +--- -Distributed under the MIT License. See `LICENSE.txt` for more information. +## **License** +Distributed under the **MIT License**. See [`LICENSE.txt`](./LICENSE.txt) for details. - -## Contact +--- -- [@CeloDevs](https://x.com/CeloDevs) -- [Discord](https://discord.com/invite/celo) +## **Contact** +- **Twitter:** [@CeloDevs](https://x.com/CeloDevs) +- **Discord:** [Celo Developer Community](https://discord.com/invite/celo) -

(back to top)

+

(Back to top)

\ No newline at end of file