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

https://github.com/ecstaticfly/referralhub

ReferralHub is a MERN stack platform designed to streamline and manage referral-based campaigns. It allows businesses to create campaigns, track referrals, and analyze campaign performance while providing users with an easy way to participate in referral programs..
https://github.com/ecstaticfly/referralhub

chatbot expressjs gemini-api jwt mongodb nodejs reactjs responsive-design smtp tailwindcss vercel-deployment vite zustand

Last synced: 2 months ago
JSON representation

ReferralHub is a MERN stack platform designed to streamline and manage referral-based campaigns. It allows businesses to create campaigns, track referrals, and analyze campaign performance while providing users with an easy way to participate in referral programs..

Awesome Lists containing this project

README

          

# ๐Ÿš€ ReferralHub โ€“ Referral Management Platform

ReferralHub is a **full-stack referral management platform** that allows businesses to **create, manage, and monitor referral campaigns**, while enabling users to **participate and share personalized referral links**. Built using the **MERN stack with Zustand, and Vercel**, the platform is scalable, secure, and designed for high performance.

๐Ÿ”— **Live Demo:** [ReferralHub](https://referral-hub-alpha.vercel.app/)
๐Ÿ“‚ **Source Code:** [GitHub](https://github.com/EcstaticFly/ReferralHub.git)

## โœจ Features
- ๐Ÿง  **Campaign Management** โ€“ Businesses can create, edit, and expire referral campaigns.
- ๐Ÿ”— **User Referrals** โ€“ Users receive **unique referral links** to invite others.
- ๐Ÿ“Š **Dashboard Analytics** โ€“ Monitor referral performance & campaign stats.
- ๐Ÿงพ **Referral History** โ€“ View all referred users and rewards per campaign.
- ๐Ÿ”’ **JWT Auth & Cookies** โ€“ Secure **authentication and session handling**.
- ๐Ÿ’ป **Responsive Design** โ€“ Built with **TailwindCSS** for full responsiveness.

## ๐Ÿ›  Tech Stack

- **Frontend:** React.js, Zustand, TailwindCSS
- **Backend:** Node.js (ES Modules), Express.js, MongoDB (Mongoose)
- **Authentication:** JWT, Cookies
- **Deployment:** Vercel

## ๐Ÿš€ Installation & Setup

1๏ธโƒฃ **Clone the repository:**
```bash
git clone https://github.com/EcstaticFly/ReferralHub.git
cd ReferralHub
```

2๏ธโƒฃ **Configure server environment variables**
```bash
#setup .env file for server
cd server
touch .env
#add in server/.env
REACT_MONGODB_URL=your_mongodb_url
CLIENT_BASE_URL=your_cors_origin
JWT_SECRET=your_jwt_secret
NODE_ENV=development
MAIL_USER=your_mail_service_email
SECRET_PASSWORD=your_mail_service_password
GEMINI_API_KEY=AIzaSyBmUPvJ3EnJBKzKYjUmtYQV9GrSHAXEzAA
```

3๏ธโƒฃ **Configure client environment variable**
```bash
#setup .env file for client
cd client
touch .env
#add in client/.env
VITE_API_URL=your_backend_api_url
```

4๏ธโƒฃ **Run the app**
```bash
#start server
cd server
npm run dev
#start client
cd client
npm run dev
```

The app will be live at http://localhost:5173

## ๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!
Feel free to **fork** the repo and submit a **pull request**.

## ๐Ÿ“œ License
This project is licensed under the **GNU GENERAL PUBLIC LICENSE v3**.

## ๐Ÿ“ฌ Contact

For inquiries, reach out to me at [Suyash Pandey](mailto:suyash.2023ug1100@iiitranchi.ac.in).