-
-
-
-## 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.
-
-
-
-## 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/)
-
-
-
-
-
-## 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).
+---
-
+## **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.
+---
-
+## **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)
-