Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wamiq319/refer-earn-system-que

A simple refer & earn system where users earn points by referring others via a unique link. Registration requires only a wallet address. The app tracks IP addresses to limit one account per user, handles wallet addresses on the frontend to prevent unusual requests, & verifies IP & query parameters on the backend to ensure security & efficiency.
https://github.com/wamiq319/refer-earn-system-que

Last synced: 20 days ago
JSON representation

Host: GitHub
URL: https://github.com/wamiq319/refer-earn-system-que
Owner: Wamiq319
Created: 2024-12-29T13:14:39.000Z (30 days ago)
Default Branch: main
Last Pushed: 2025-01-07T05:34:39.000Z (21 days ago)
Last Synced: 2025-01-07T06:25:44.581Z (21 days ago)
Language: JavaScript
Homepage:
Size: 847 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# **Que Referral and Earn System**

## **Project Overview**

The **Referral and Earn System** is a simple web application designed to allow users to:

- **Add a wallet address**
- **Generate a unique referral link** associated with that wallet address
- **Track their balance**, which increases when others use their referral link
- **Earn points** when successful referrals occur

This system focuses on the referral mechanism, without any integration with third-party apps like Telegram. It is a stand-alone app to handle user referrals and point accumulation.

---

## **Problem Statement**

The goal of this project is to provide a straightforward solution where users can:

1. Add a wallet address to their profile
2. Generate and share a unique referral link
3. View their balance and track earnings from successful referrals
4. Earn points for each successful referral

---

## **Inspiration**

The system’s concept and flow were inspired by the following platforms:

- [NFT Sea](https://web.archive.org/web/20211006140559/http://nftsea.net/)
- [Solfi](https://solfi.pro/?1A094)

These sites provided ideas for generating referral links tied to wallet addresses and displaying balance information.

---

## **Tech Stack**

### **Frontend**:

- **React**: For building a dynamic, single-page user interface. React allows the creation of reusable components, making the app easy to maintain and scale.
- **Tailwind CSS**: A utility-first CSS framework used to create a responsive, minimalist, and customizable design.

### **Backend**:

- **Node.js with Express**: The backend uses Node.js and Express to handle user requests like adding wallet addresses, generating referral links, and fetching user balances.
- **MongoDB (Atlas)**: A document-oriented NoSQL database. MongoDB’s flexibility and scalability make it ideal for this project. MongoDB Atlas offers a managed cloud service with automatic backups and enhanced security features.

---

## **Security Features**

### **Frontend**:

- Frontend validation ensures proper format for wallet addresses and data to minimize unnecessary backend requests.

### **Backend**:

- A robust security layer validates incoming data on every route to ensure it meets application standards before interacting with the database.

---

## **Special Notes for Developers**

- The system includes a daily claim feature and a route for updating reward claims. If additional claim options are needed (e.g., monthly or one-time claims), you can extend the functionality by adding a few fields to the database. No extra logic is necessary, as the system is designed for scalability.

---

## **Installation Instructions**

To get the project up and running locally, follow these steps:

### **Clone the Repository**:

```bash
git clone https://github.com/your-username/Refer-Earn-System-Que.git
cd Frontend
```
Check Frontend and Backend folder and there Readme files for further details