Install and configure refferq

Follow the source instructions for refferq. Read the prerequisites and configuration steps before running an example.

Installation

Prerequisites

Node.js 18.x or higher
PostgreSQL 14.x or higher
npm or yarn or pnpm

Step 1: Clone the Repository

1git clone https://github.com/Up-to-code/refferq.git
2cd refferq

Step 2: Install Dependencies

1npm install
2# or
3yarn install
4# or
5pnpm install

Step 3: Environment Setup

Create a .env.local file in the root directory:

1# Database
2DATABASE_URL="postgresql://user:password@localhost:5432/refferq"
3
4# JWT Secret (generate a secure random string)
5JWT_SECRET="your-super-secret-jwt-key-min-32-chars"
6
7# Email Configuration (Resend)
8# Sign up at https://resend.com for free API key
9RESEND_API_KEY="re_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
10RESEND_FROM_EMAIL="Refferq <onboarding@resend.dev>"
11
12# Admin Notification Emails (comma-separated)
13ADMIN_EMAILS="admin@yourdomain.com"
14
15# Application URL
16NEXT_PUBLIC_APP_URL="http://localhost:3000"
17
18# Optional: Stripe (for payments)
19STRIPE_SECRET_KEY="sk_test_..."
20STRIPE_PUBLISHABLE_KEY="pk_test_..."

Step 4: Database Setup

1# Generate Prisma Client
2npx prisma generate
3 
4# Push schema to database
5npx prisma db push
6 
7# (Optional) Seed database with sample data
8npx prisma db seed

Step 5: Email Configuration

Refferq uses Resend for sending transactional emails. Follow these steps:

Sign up for Resend
- Go to https://resend.com
- Create a free account (3,000 emails/month)
Get your API Key
- Navigate to API Keys in Resend dashboard
- Create a new API key
- Copy the key (starts with re_...)

Update .env.local

1RESEND_API_KEY="re_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
2RESEND_FROM_EMAIL="Refferq <onboarding@resend.dev>"
3ADMIN_EMAILS="admin@yourdomain.com"

Test Email Setup (Optional)

1curl -X POST http://localhost:3000/api/admin/emails/test \
2  -H "Content-Type: application/json" \
3  -d '{"type": "welcome", "to": "test@example.com"}'

Note: For production, verify your domain in Resend dashboard to use your own email addresses. See docs/EMAIL.md for detailed configuration guide.

Step 6: Run Development Server

1npm run dev

Open https://app.refferq.com or your configured domain in your browser.

or

yarn dev

or

pnpm dev

1
2Open [http://localhost:3000](http://localhost:3000) in your browser.
3
4### Step 7: Create Admin Account
5
61. Register at `/register`
72. Use the registration form to create your account
83. Manually update the user role in the database:
9
10```sql
11UPDATE users SET role = 'ADMIN', status = 'ACTIVE' WHERE email = 'your-email@example.com';

Note: New affiliates are set to PENDING status by default and require admin approval. Admins should be set to ACTIVE status.

📦 Deployment

Deploy on Vercel

The easiest way to deploy Refferq is using Vercel:

Manual Deployment Steps:

Push to GitHub
Terminal
Shell
```
1git push origin main
```
Import Project in Vercel
- Go to Vercel Dashboard
- Click "New Project"
- Import your repository
Configure Environment Variables
- Add all variables from .env.local
- Set DATABASE_URL to your production database
Deploy
- Vercel will automatically build and deploy
- Get your production URL: https://your-project.vercel.app

For detailed deployment instructions, see DEPLOYMENT.md

📚 Documentation

API Documentation - Complete API reference
Deployment Guide - Production deployment steps
Database Schema - Database structure and models
Email Configuration - Email setup and templates guide
Contributing Guide - How to contribute

🗂️ Project Structure

refferq/ ├── prisma/ │ └── schema.prisma # Database schema ├── public/ │ └── images/ # Static assets ├── src/ │ ├── app/ │ │ ├── admin/ # Admin dashboard │ │ ├── affiliate/ # Affiliate dashboard │ │ ├── api/ # API routes │ │ │ ├── admin/ # Admin endpoints │ │ │ ├── affiliate/ # Affiliate endpoints │ │ │ └── auth/ # Authentication │ │ ├── login/ # Login page │ │ └── register/ # Registration page │ ├── components/ # React components │ ├── hooks/ # Custom hooks │ ├── context/ # React context │ └── icons/ # SVG icons ├── docs/ # Documentation ├── .env.local # Environment variables ├── vercel.json # Vercel configuration └── README.md # This file

🔧 Configuration

Program Settings

Configure your affiliate program through the Admin Dashboard:

General Settings
- Product name and program name
- Website URL
- Currency (INR, USD, EUR, GBP)
- Blocked countries
Branding
- Brand colors (background, button, text)
- Company logo
- Favicon
Payout Settings
- Minimum payout threshold
- Payout term (NET-15, NET-30, NET-45)
- Supported payout methods
Marketing & Tracking
- Cookie duration
- URL parameters
- Manual lead submission
- Social media ad blocking

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

Fork the repository
Create a feature branch
Make your changes
Run tests: npm test
Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

👨‍💻 Author

Developed by: Refferq Team

GitHub: @refferq
Website: https://refferq.com

🌟 Show Your Support

If you find this project useful, please consider:

⭐ Starring the repository
🐛 Reporting bugs
💡 Suggesting new features
🔀 Submitting pull requests

📞 Support

Documentation: docs/
Issues: GitHub Issues
Discussions: GitHub Discussions

Star History

🙏 Acknowledgments

Built with ❤️ using:

Made with ❤️ by the Refferq Team

⭐ Found this useful? Give us a star to support the project!

Check the installation

After setup, continue with the first example. If a command fails, compare the runtime version, working directory, and required configuration with the original README before changing dependencies.

Source and help

The catalog identifies the license as MIT. Read the repository license before redistributing source or assets.

This catalog entry is a fork. The README may describe upstream packages, domains, or release procedures; those destinations do not establish a separate release of this fork.