|
1 |
| -# ZKonnect: Decentralized Event Management and Ticketing |
| 1 | +# 🏗 Scaffold-ETH 2 |
2 | 2 |
|
3 |
| -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. |
| 3 | +**Note**: Switch to mainreplica for the updated code of the project zKonnect. |
| 4 | +<h4 align="center"> |
| 5 | + <a href="https://docs.scaffoldeth.io">Documentation</a> | |
| 6 | + <a href="https://scaffoldeth.io">Website</a> |
| 7 | +</h4> |
4 | 8 |
|
5 |
| -## **Features** |
| 9 | +🧪 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. |
6 | 10 |
|
7 |
| -### For Organizers: |
8 |
| -- **Event Creation**: Organizers can create events by specifying details like event name, image, maximum attendees, and a secret staking ID. |
9 |
| -- **Editable Event Details**: Organizers can modify event details as needed, stored securely on-chain or via decentralized storage. |
10 |
| -- **Secure Ticket Validation**: Attendees are validated on the day of the event using Zero-Knowledge Proofs (zkProofs). |
| 11 | +⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, and Typescript. |
11 | 12 |
|
12 |
| -### For Buyers: |
13 |
| -- **Role-Based Access Control**: Buyers and organizers have separate views, authenticated using MetaMask wallet addresses. |
14 |
| -- **Seamless Ticket Purchase**: Buyers stake a secret ID, verify using zkProofs, and pay via cryptocurrency. |
15 |
| -- **NFT Ticketing**: After purchasing, buyers receive a minted NFT containing event details and a zkProof-generated hash as a secure ticket. |
| 13 | +- ✅ **Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it. |
| 14 | +- 🪝 **[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. |
| 15 | +- 🧱 [**Components**](https://docs.scaffoldeth.io/components/): Collection of common web3 components to quickly build your frontend. |
| 16 | +- 🔥 **Burner Wallet & Local Faucet**: Quickly test your application with a burner wallet and local faucet. |
| 17 | +- 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Ethereum network. |
16 | 18 |
|
17 |
| -### Decentralized Technologies Used: |
18 |
| -- **Polygon zkEVM**: For deploying scalable and cost-efficient smart contracts on the testnet. |
19 |
| -- **zkRollups**: For secure, fast transactions and staking secret IDs. |
20 |
| -- **MetaMask and Coinbase Wallet**: For user authentication via wallet addresses and managing cryptocurrency payments. |
21 |
| -- **Circom and Snark.js**: For zkProof generation and validation. |
22 |
| -- **Next.js**: For building a performant, modern frontend. |
23 |
| -- **Hardhat**: For developing and deploying smart contracts. |
24 |
| -- **Scaffold-ETH2**: For bootstrapping the frontend with Ethereum integration. |
| 19 | + |
25 | 20 |
|
26 |
| ---- |
| 21 | +## Requirements |
27 | 22 |
|
28 |
| -## **Setup Instructions** |
| 23 | +Before you begin, you need to install the following tools: |
29 | 24 |
|
30 |
| -### **Prerequisites** |
31 |
| -- Node.js (v16 or higher) |
32 |
| -- Yarn or npm |
33 |
| -- Hardhat (for smart contract deployment) |
34 |
| -- MetaMask wallet extension |
35 |
| -- Polygon zkEVM testnet configuration |
| 25 | +- [Node (>= v18.18)](https://nodejs.org/en/download/) |
| 26 | +- Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install)) |
| 27 | +- [Git](https://git-scm.com/downloads) |
36 | 28 |
|
37 |
| -### **1. Clone the Repository** |
38 |
| -```bash |
39 |
| -git clone https://github.com/your-username/zkonnect.git |
40 |
| -cd zkonnect |
41 |
| -``` |
| 29 | +## Quickstart |
| 30 | + |
| 31 | +To get started with Scaffold-ETH 2, follow the steps below: |
42 | 32 |
|
43 |
| -### **2. Install Dependencies** |
44 |
| -#### For Scaffold-ETH2 Setup |
45 |
| -- Install required tools: |
46 |
| - ```bash |
47 |
| - cd my-dapp-example |
48 |
| - yarn install |
49 |
| - ``` |
| 33 | +1. Install dependencies if it was skipped in CLI: |
| 34 | + |
| 35 | +``` |
| 36 | +cd my-dapp-example |
| 37 | +yarn install |
| 38 | +``` |
50 | 39 |
|
51 | 40 | #### For ZKonnect Setup
|
52 | 41 | ```bash
|
|
0 commit comments