Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thesanjeevsharma/loyal-chain
Hackathon repo for ETH Tokyo'24.
https://github.com/thesanjeevsharma/loyal-chain
Last synced: about 5 hours ago
JSON representation
Hackathon repo for ETH Tokyo'24.
- Host: GitHub
- URL: https://github.com/thesanjeevsharma/loyal-chain
- Owner: thesanjeevsharma
- Created: 2024-08-24T16:36:32.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-24T23:31:12.000Z (3 months ago)
- Last Synced: 2024-10-12T02:44:05.659Z (27 days ago)
- Language: TypeScript
- Homepage: https://loyal-chain-eth.vercel.app
- Size: 2.27 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **NFT Loyalty Program Platform**
## **Demo**
Link: [https://loyal-chain-eth.vercel.app](https://loyal-chain-eth.vercel.app)
Video: [https://youtu.be/g-POtTkWzuw](https://youtu.be/g-POtTkWzuw)
## **Overview**
Our platform revolutionizes loyalty programs for cafes, restaurants, and hotels by leveraging NFTs. Businesses can register and issue NFT collections, which users can purchase to earn loyalty points. These points unlock exclusive offers and can be traded for monetary value.
## **Problem Statement**
Traditional loyalty programs are fragmented and often lack transparency and flexibility. Users are forced to manage multiple cards or apps, and the rewards are often limited to specific businesses. Our platform aims to unify these programs into a single, user-friendly system that enhances customer engagement and retention.
## **Solution**
We provide a decentralized platform where:
- **Businesses**: Register and create NFT collections representing their loyalty programs.
- **Users**: Purchase NFTs to earn loyalty points. These points are tied to the NFT token ID in our contract, allowing users to redeem offers or trade their assets.
### **Key Features**
- **Unified Platform**: All participating businesses are listed, making it easy for users to discover new loyalty opportunities.
- **NFT-Based System**: NFTs represent loyalty points, offering transparency and security.
- **Flexible Rewards**: Users can redeem points for offers or trade their NFTs for money.
- **Smart Contracts**: All transactions are securely managed by smart contracts, ensuring fairness and trust.
## Software Architecture
```mermaid
graph TD;
A[Company] -->|Registers| B[Registry Contract];
B -->|Stores| C[Information];
C -->|Includes| D[NFT Collection Address];
E[User] -->|Views| B;
E -->|Buys NFT| F[RewardNFT Contract];
F -->|Mints| G[Loyalty NFT];
G -->|Mapped to| H[Reward Points];
E -->|Visits Place| I[Increase Loyalty];
I -->|Updates| H;
J[Hotel Owner] -->|Mints NFTs| F;
J -->|Sets Price| F;
E -->|Views Own NFTs| K[NFT Information];
K -->|Includes| L[Token ID];
K -->|Includes| M[Category];
K -->|Includes| N[Reward Points];
K -->|Includes| O[For Sale Status];
K -->|Includes| P[Price];
style B fill:#9B5094,stroke:#fff,stroke-width:2px;
style F fill:#6A605C,stroke:#fff,stroke-width:2px;
```
## **Technology Stack**
- **Frontend**: Next.js
- **Blockchain**: Ethereum, Solidity, BNB Greenfield
- **Smart Contracts**: ERC-721 standard for NFTs
- **Deployment**: Vercel
## **How It Works**
1. **Business Registration**: Cafes, restaurants, and hotels register on our platform via contract and create their NFT collections.
2. **User Interaction**: Users browse the platform, purchase NFTs, and earn loyalty points mapped to the NFT token ID.
3. **Redeem & Trade**: Users can redeem points for offers or trade their NFTs on supported marketplaces.
## **Setup Instructions**
1. Clone the repository: `git clone https://github.com/thesanjeevsharma/loyal-chain`
2. Install dependencies: `npm install`
3. Start the development server: `npm run dev`
4. Deploy the smart contracts: Follow the instructions in the `https://github.com/thesanjeevsharma/loyal-chain/tree/main/web3-link`.
## **Bounty Usage**
1. Scroll Contracts - [0x4B5Cf880D79360F8f39376d7A456Fe1c3f109EBD](https://sepolia.scrollscan.com/address/0x4B5Cf880D79360F8f39376d7A456Fe1c3f109EBD), [0xB0d056f88241Cd95a97f60629C2762dfe25b7220](https://sepolia.scrollscan.com/address/0xB0d056f88241Cd95a97f60629C2762dfe25b7220), [0x398D0e9098b0Eb723d35790C9538899E6348725a](https://sepolia.scrollscan.com/address/0x398D0e9098b0Eb723d35790C9538899E6348725a), [0xe1Cfa8f693b094793e52990d91825F80FB124De7](https://sepolia.scrollscan.com/address/0xe1Cfa8f693b094793e52990d91825F80FB124De7)
2. Binance Contract - [0x6BA806b09539b6E37e7A7C41017f563BA43562De](https://testnet.bscscan.com/address/0x6BA806b09539b6E37e7A7C41017f563BA43562De)
3. BNB Greenfield - All Assets are stored in greenfield [example](https://gnfd-testnet-sp1.bnbchain.org/view/sakura-3stays/nft6.webp)
4. ENS Usage - [Line 21-38](https://github.com/thesanjeevsharma/loyal-chain/blob/main/components/NavBar/index.tsx)
## **Future Enhancements**
- Integration with additional blockchain networks.
- Mobile app development for on-the-go access.
- AI-powered recommendation engine for personalized offers.
## **Contributors**
- [Sanjeev Sharma](https://github.com/thesanjeevsharma)
- [Ravish Sharma](https://github.com/ravish1729)
## **License**
This project is licensed under the MIT License.
## **Contact**
For any inquiries, please contact us at [https://thesanjeevsharma.vercel.app](https://thesanjeevsharma.vercel.app).