Skip to content

Commit 0740f43

Browse files
authored
Improved README.md
Added images and links to the videos from the Devfolio Project Board
1 parent 87f1748 commit 0740f43

File tree

1 file changed

+28
-58
lines changed

1 file changed

+28
-58
lines changed

README.md

Lines changed: 28 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
1-
# ZKonnect: Decentralized Event Management and Ticketing
1+
# ZKonnect: Decentralized Event Management and Ticketing powered by Zero Knowledge.
2+
3+
<p align="center">
4+
<img src="https://github.com/user-attachments/assets/aa342c7e-8ca2-4d95-a2f1-598c32d79cad" alt="Sublime's custom image"/>
5+
</p>
26

37
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.
48

59
## **Features**
610

711
### For Organizers:
12+
![image](https://github.com/user-attachments/assets/81ad9f8c-a959-419e-acb1-11b5bc5db70d)
13+
814
- **Event Creation**: Organizers can create events by specifying details like event name, image, maximum attendees, and a secret staking ID.
915
- **Editable Event Details**: Organizers can modify event details as needed, stored securely on-chain or via decentralized storage.
1016
- **Secure Ticket Validation**: Attendees are validated on the day of the event using Zero-Knowledge Proofs (zkProofs).
1117

1218
### For Buyers:
13-
- **Role-Based Access Control**: Buyers and organizers have separate views, authenticated using MetaMask wallet addresses.
19+
![Screencast from 2024-12-12 15-19-29](https://github.com/user-attachments/assets/0025a082-6017-40e4-bb28-d0cf28ab082f)
20+
21+
- **Role-Based Access Control**: Buyers and organizers have separate views, authenticated using MetaMask/Coinbase wallet addresses.
1422
- **Seamless Ticket Purchase**: Buyers stake a secret ID, verify using zkProofs, and pay via cryptocurrency.
1523
- **NFT Ticketing**: After purchasing, buyers receive a minted NFT containing event details and a zkProof-generated hash as a secure ticket.
1624

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.
25-
2625
---
2726

2827
## **Setup Instructions**
@@ -32,33 +31,21 @@ ZKonnect is a blockchain-based event management and ticketing platform that leve
3231
- Yarn or npm
3332
- Hardhat (for smart contract deployment)
3433
- MetaMask wallet extension
35-
- Polygon zkEVM testnet configuration
34+
- Polygon zkEVM/Amoy testnet configuration
3635

3736
### **1. Clone the Repository**
3837
```bash
39-
git clone https://github.com/your-username/zkonnect.git
40-
cd zkonnect
38+
git clone https://github.com/your-username/ETH24Submission.git
39+
cd ETH24Submission
4140
```
4241

4342
### **2. Install Dependencies**
4443
#### For Scaffold-ETH2 Setup
4544
- Install required tools:
4645
```bash
47-
cd my-dapp-example
4846
yarn install
4947
```
5048

51-
#### For ZKonnect Setup
52-
```bash
53-
# Install backend dependencies
54-
cd backend
55-
npm install
56-
57-
# Install frontend dependencies
58-
cd ../frontend
59-
npm install
60-
```
61-
6249
### **3. Smart Contract Deployment**
6350
#### Scaffold-ETH2
6451
1. Run a local Ethereum network in the first terminal:
@@ -74,16 +61,16 @@ npm install
7461
#### ZKonnect
7562
1. Navigate to the backend directory:
7663
```bash
77-
cd backend
64+
cd packages/hardhat
7865
```
79-
2. Configure the deployment network in `hardhat.config.js` (e.g., Polygon zkEVM testnet or local network).
66+
2. Configure the deployment network in `hardhat.config.js` (e.g., Polygon zkEVM/Amoy testnet or local network).
8067
3. Compile the contracts:
8168
```bash
8269
npx hardhat compile
8370
```
8471
4. Deploy the smart contracts:
8572
```bash
86-
npx hardhat run scripts/deploy.js --network zkEVM
73+
npx hardhat deploy --network polygonZkEvm
8774
```
8875
5. Copy the deployed contract address and update the frontend configuration file (`frontend/src/config.js`).
8976

@@ -104,11 +91,11 @@ Visit the app at `http://localhost:3000`.
10491
#### ZKonnect
10592
1. Navigate to the frontend directory:
10693
```bash
107-
cd ../frontend
94+
cd ../nextjs
10895
```
10996
2. Start the development server:
11097
```bash
111-
npm run dev
98+
yarn start
11299
```
113100
3. Open the app in your browser at `http://localhost:3000`.
114101

@@ -125,45 +112,28 @@ Visit the app at `http://localhost:3000`.
125112
1. Login with MetaMask or Coinbase Wallet.
126113
2. Browse events and select an event.
127114
3. Enter the secret staking ID and pay using cryptocurrency.
128-
4. Receive an NFT ticket as proof of purchase.
115+
4. Receive an NFT ticket as proof of purchase. Wait for the event :)
129116

130117
### **Event Verification**:
131-
- On the event day, buyers provide their zkProof-generated hash, which the organizer verifies to grant entry.
132-
118+
- 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.
119+
[![Deep Dive into out architecture](https://img.youtube.com/vi/VIDEO_ID/0.jpg)](https://www.youtube.com/watch?v=fGA3MQ0U6fA)
133120
---
134121

135122
## **Technologies Used**
136123

137-
### **Blockchain**:
138-
- **Polygon zkEVM**: For scalable and efficient smart contract deployment.
139-
- **zkRollups**: To ensure fast, low-cost, and secure transactions.
124+
### **Blockchain and smart contracts**:
125+
![image](https://github.com/user-attachments/assets/d96ba7fd-a3f6-4212-9651-c2ab6193a74f)
126+
![image](https://github.com/user-attachments/assets/4347563b-beb3-4aa5-b541-2ab4d3653765)
127+
![image](https://github.com/user-attachments/assets/173af87d-86cd-4db2-bf2c-d611f52fa9b0)
140128

141129
### **Authentication**:
142-
- **MetaMask and Coinbase Wallet**: Wallet-based authentication for role-based access control and payments.
130+
![image](https://github.com/user-attachments/assets/32ce03ce-47ff-43c1-b576-808a5abefbbb)
131+
![image](https://github.com/user-attachments/assets/3968f01d-a999-41b9-b477-d571f6576422)
132+
143133

144134
### **Proof Generation**:
145135
- **Circom and Snark.js**: For generating and validating zkProofs to secure sensitive data.
146136

147137
### **Frontend**:
148138
- **Next.js**: For a modern, responsive, and performant frontend.
149139
- **Scaffold-ETH2**: For integrating Ethereum and bootstrapping frontend components.
150-
151-
### **Smart Contract Development**:
152-
- **Hardhat**: For developing, testing, and deploying smart contracts on Polygon zkEVM.
153-
154-
---
155-
156-
## **Alternate Use Cases**
157-
1. **Event Certification**: Use ZKonnect for certification of event participation using NFTs.
158-
2. **Decentralized Memberships**: Manage memberships or subscriptions for exclusive events or communities.
159-
3. **Fraud-Proof Ticket Resale**: Enable secure, verifiable resale of tickets using NFT ownership transfer.
160-
161-
---
162-
163-
## **Contributing**
164-
We welcome contributions to improve ZKonnect. Please open an issue or submit a pull request.
165-
166-
---
167-
168-
## **License**
169-
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)