Skip to main content
Buy on CodeCanyon
ESC

Searching...

Quick Links

Documentation Home Getting Started

Type to search • Press ↑ ↓ to navigate • Enter to select

Keep typing to search...

No results found

No documentation matches ""

Documentation
Back to Home Buy on CodeCanyon

Installation

Step-by-step guide to installing Reward Loyalty.

Dec 5, 2025

📋 Who This Is For

Reward Loyalty is self-hosted source code for developers and agencies. You'll need basic Laravel/PHP experience and your own hosting. We provide the code and comprehensive documentation—you handle deployment and maintenance.

This guide walks you through installing Reward Loyalty. The process takes about 5 minutes.

Quick Start

  1. Extract the downloaded package
  2. Upload files to your web directory
  3. Visit your domain
  4. Follow the installation wizard

Detailed Steps

Step 1: Extract and Upload

After purchasing from CodeCanyon, download the package. Extract the contents of the public_html directory and upload them to your web root.

Important: Install at your domain root (e.g., loyalty.example.com), not in a subdirectory (e.g., example.com/loyalty). Use a subdomain if needed.

Step 2: Run the Installer

Navigate to your domain in a browser. You'll see the installation screen.

The installer guides you through three steps:

Step 1: Server Requirements

  • Verifies PHP version (8.1 or higher)
  • Checks required PHP extensions
  • Validates file permissions

Step 2: Configuration

  • Application Settings — Set your app name and upload a logo
  • Admin Account — Create your administrator account with email and timezone
  • Database — Enter your database credentials
  • Email Delivery — Configure email sending (required for login)

Step 3: Installation

  • Creates database tables
  • Saves configuration
  • Finalizes setup

Step 3: Email Configuration (Essential)

Email is not optional—it's essential for the application to function. Reward Loyalty uses passwordless OTP authentication, which means users receive a verification code via email to log in.

During Step 2, you'll configure email delivery:

  1. Enter your From Email and From Name (what recipients will see)
  2. Select a mail driver by clicking on one of the visual cards:
    • For production: SMTP, Mailgun, Amazon SES, Postmark, Resend, or Sendmail
    • For local development: Mailpit or Log File
  3. Fill in driver-specific settings (host, port, API keys, etc.)
  4. (Recommended) Send a test email to verify your configuration works

Common choices:

  • Most users: SMTP Server (works with any email provider)
  • Local development: Mailpit (catches emails locally without sending)
  • Production at scale: Mailgun, Amazon SES, or Postmark

For detailed email configuration instructions, see the Email Configuration Guide.

⚠️ Warning: Without working email, no one can log in. Always test your email configuration before completing installation.

Step 4: Complete Setup

After configuring email, click "Next" to proceed to Step 3 (Installation). The installer will:

  1. Create database tables
  2. Save your configuration to the .env file
  3. Set up the admin account
  4. Redirect you to the homepage

Installation typically completes in under a minute.

After Installation

Log in to the admin dashboard at /admin using the credentials you created during installation.

First steps as admin:

  1. Go to License & Updates to activate your license
  2. Create your first network
  3. Assign a manager or create partners directly

Local Development

For local development, use Laravel's built-in server:

cd /path/to/reward-loyalty
php artisan serve

Access the application at http://localhost:8000.

Next Steps