Merge mainreplica into main [skip ci]

Author: swrjsingh

README.md

@@ -1,80 +1,139 @@
-# 🏗 Scaffold-ETH 2
+# ZKonnect: Decentralized Event Management and Ticketing powered by Zero Knowledge.
 
-<h4 align="center">
-  <a href="https://docs.scaffoldeth.io">Documentation</a> |
-  <a href="https://scaffoldeth.io">Website</a>
-</h4>
+<p align="center">
+  <img src="https://github.com/user-attachments/assets/aa342c7e-8ca2-4d95-a2f1-598c32d79cad" alt="Sublime's custom image"/>
+</p>
 
-🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.
+ZKonnect is a blockchain-based event management and ticketing platform that leverages decentralized technologies to enhance transparency, security, and fairness in ticketing systems. Designed for organizers and attendees, ZKonnect eliminates ticket fraud, prevents black-market reselling, and enables seamless event management with role-based access control.
 
-⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, and Typescript.
+## **Features**
 
-- ✅ **Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it.
-- 🪝 **[Custom hooks](https://docs.scaffoldeth.io/hooks/)**: Collection of React hooks wrapper around [wagmi](https://wagmi.sh/) to simplify interactions with smart contracts with typescript autocompletion.
-- 🧱 [**Components**](https://docs.scaffoldeth.io/components/): Collection of common web3 components to quickly build your frontend.
-- 🔥 **Burner Wallet & Local Faucet**: Quickly test your application with a burner wallet and local faucet.
-- 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Ethereum network.
+### For Organizers:
+![image](https://github.com/user-attachments/assets/81ad9f8c-a959-419e-acb1-11b5bc5db70d)
 
-![Debug Contracts tab](https://github.com/scaffold-eth/scaffold-eth-2/assets/55535804/b237af0c-5027-4849-a5c1-2e31495cccb1)
+- **Event Creation**: Organizers can create events by specifying details like event name, image, maximum attendees, and a secret staking ID.
+- **Editable Event Details**: Organizers can modify event details as needed, stored securely on-chain or via decentralized storage.
+- **Secure Ticket Validation**: Attendees are validated on the day of the event using Zero-Knowledge Proofs (zkProofs).
 
-## Requirements
+### For Buyers:
+![Screencast from 2024-12-12 15-19-29](https://github.com/user-attachments/assets/0025a082-6017-40e4-bb28-d0cf28ab082f)
 
-Before you begin, you need to install the following tools:
+- **Role-Based Access Control**: Buyers and organizers have separate views, authenticated using MetaMask/Coinbase wallet addresses.
+- **Seamless Ticket Purchase**: Buyers stake a secret ID, verify using zkProofs, and pay via cryptocurrency.
+- **NFT Ticketing**: After purchasing, buyers receive a minted NFT containing event details and a zkProof-generated hash as a secure ticket.
 
-- [Node (>= v18.18)](https://nodejs.org/en/download/)
-- Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install))
-- [Git](https://git-scm.com/downloads)
+---
 
-## Quickstart
+## **Setup Instructions**
 
-To get started with Scaffold-ETH 2, follow the steps below:
+### **Prerequisites**
+- Node.js (v16 or higher)
+- Yarn or npm
+- Hardhat (for smart contract deployment)
+- MetaMask wallet extension
+- Polygon zkEVM/Amoy testnet configuration
 
-1. Install dependencies if it was skipped in CLI:
-
-```
-cd my-dapp-example
-yarn install
+### **1. Clone the Repository**
+```bash
+git clone https://github.com/your-username/ETH24Submission.git
+cd ETH24Submission
 ```
 
-2. Run a local network in the first terminal:
-
+### **2. Install Dependencies**
+#### For Scaffold-ETH2 Setup
+- Install required tools:
+  ```bash
+  yarn install
+  ```
+
+### **3. Smart Contract Deployment**
+#### Scaffold-ETH2
+1. Run a local Ethereum network in the first terminal:
+   ```bash
+   yarn chain
+   ```
+
+2. Deploy the test contract on a second terminal:
+   ```bash
+   yarn deploy
+   ```
+
+#### ZKonnect
+1. Navigate to the backend directory:
+   ```bash
+   cd packages/hardhat
+   ```
+2. Configure the deployment network in `hardhat.config.js` (e.g., Polygon zkEVM/Amoy testnet or local network).
+3. Compile the contracts:
+   ```bash
+   npx hardhat compile
+   ```
+4. Deploy the smart contracts:
+   ```bash
+   npx hardhat deploy --network polygonZkEvm
+   ```
+5. Copy the deployed contract address and update the frontend configuration file (`frontend/src/config.js`).
+
+### **4. Run the Backend**
+Start the backend server:
+```bash
+npm start
 ```
-yarn chain
-```
-
-This command starts a local Ethereum network using Hardhat. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in `packages/hardhat/hardhat.config.ts`.
-
-3. On a second terminal, deploy the test contract:
 
+### **5. Run the Frontend**
+#### Scaffold-ETH2
+Start the Next.js app:
+```bash
+yarn start
 ```
-yarn deploy
-```
-
-This command deploys a test smart contract to the local network. The contract is located in `packages/hardhat/contracts` and can be modified to suit your needs. The `yarn deploy` command uses the deploy script located in `packages/hardhat/deploy` to deploy the contract to the network. You can also customize the deploy script.
+Visit the app at `http://localhost:3000`.
 
-4. On a third terminal, start your NextJS app:
+#### ZKonnect
+1. Navigate to the frontend directory:
+   ```bash
+   cd ../nextjs
+   ```
+2. Start the development server:
+   ```bash
+   yarn start
+   ```
+3. Open the app in your browser at `http://localhost:3000`.
 
-```
-yarn start
-```
+---
 
-Visit your app on: `http://localhost:3000`. You can interact with your smart contract using the `Debug Contracts` page. You can tweak the app config in `packages/nextjs/scaffold.config.ts`.
+## **How It Works**
 
-Run smart contract test with `yarn hardhat:test`
+### **Organizer Workflow**:
+1. Login with MetaMask or Coinbase Wallet.
+2. Create an event by filling in event details and uploading images.
+3. Manage and edit event details stored securely on Polygon zkEVM.
 
-- Edit your smart contracts in `packages/hardhat/contracts`
-- Edit your frontend homepage at `packages/nextjs/app/page.tsx`. For guidance on [routing](https://nextjs.org/docs/app/building-your-application/routing/defining-routes) and configuring [pages/layouts](https://nextjs.org/docs/app/building-your-application/routing/pages-and-layouts) checkout the Next.js documentation.
-- Edit your deployment scripts in `packages/hardhat/deploy`
+### **Buyer Workflow**:
+1. Login with MetaMask or Coinbase Wallet.
+2. Browse events and select an event.
+3. Enter the secret staking ID and pay using cryptocurrency.
+4. Receive an NFT ticket as proof of purchase. Wait for the event :)
 
+### **Event Verification**:
+- On the event day, buyers provide their zkProof-generated hash, which the organizer verifies to grant entry, and all of this is automated via QR codes.
+[![Deep Dive into out architecture](https://img.youtube.com/vi/VIDEO_ID/0.jpg)](https://www.youtube.com/watch?v=fGA3MQ0U6fA)
+---
 
-## Documentation
+## **Technologies Used**
 
-Visit our [docs](https://docs.scaffoldeth.io) to learn how to start building with Scaffold-ETH 2.
+### **Blockchain and smart contracts**:
+![image](https://github.com/user-attachments/assets/d96ba7fd-a3f6-4212-9651-c2ab6193a74f)
+![image](https://github.com/user-attachments/assets/4347563b-beb3-4aa5-b541-2ab4d3653765)
+![image](https://github.com/user-attachments/assets/173af87d-86cd-4db2-bf2c-d611f52fa9b0)
 
-To know more about its features, check out our [website](https://scaffoldeth.io).
+### **Authentication**:
+![image](https://github.com/user-attachments/assets/32ce03ce-47ff-43c1-b576-808a5abefbbb)
+![image](https://github.com/user-attachments/assets/3968f01d-a999-41b9-b477-d571f6576422)
 
-## Contributing to Scaffold-ETH 2
 
-We welcome contributions to Scaffold-ETH 2!
+### **Proof Generation**:
+- **Circom and Snark.js**: For generating and validating zkProofs to secure sensitive data.
 
-Please see [CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) for more information and guidelines for contributing to Scaffold-ETH 2.
+### **Frontend**:
+- **Next.js**: For a modern, responsive, and performant frontend.
+- **Scaffold-ETH2**: For integrating Ethereum and bootstrapping frontend components.