1. Introduction

ReadX is a modern community script inspired by Reddit, allowing users to create topic-based communities, engage in discussions, and monetize through various built-in systems. This documentation provides a step-by-step guide to installing, configuring, and managing ReadX.

2. System Requirements

To run ReadX, your server must meet the following requirements:

  • PHP 7.4 or higher
  • MySQL 5.7+ or MariaDB
  • Apache or Nginx with mod_rewrite enabled
  • cURL and OpenSSL enabled
  • GD Library for image processing

3. Installation

Step 1: Upload Files

  1. Download the ReadX package.
  2. Upload the files to your server using FTP or the hosting panel.

Step 2: Create a Database

  1. Log in to your hosting control panel (e.g., cPanel).
  2. Navigate to MySQL Databases and create a new database.
  3. Create a database user and assign it to the database with all privileges.

Step 3: Run the Installer

  1. Open your browser and visit yourdomain.com/install.
  2. Follow the installation wizard by entering your database details and site settings.
  3. Click Install and wait for the setup to complete.

Step 4: Admin Login

Use the default credentials provided during installation.

After installation, log in to the admin panel at yourdomain.com/admin.

4. Configuration

General Settings

  • Navigate to Admin Panel > Settings to configure site name, logo, and meta tags.
  • Set up user registration options and email verification.

Articles

Community Management

  • Create and manage topic-based communities.
  • Set rules and moderation options for each community.

Avatar Creator & Marketplace

  • Enable the avatar creator to allow users to design their characters.
  • Configure the marketplace for buying and selling avatar items.

Monetization

  • Set up premium membership plans to offer exclusive features.
  • Enable commission-based earnings from marketplace transactions.

5. Payment Integration

ReadX supports multiple payment gateways, similar to Sngine:

  • PayPal
  • Stripe
  • Coinbase (for crypto payments)

To configure payments:

  1. Go to Admin Panel > Payments.
  2. Enter API keys for your preferred payment gateways.
  3. Set commission rates and payout thresholds.

6. User Management

  • Assign user roles (admin, moderator, user).
  • Manage bans and content reports.
  • Track user karma and achievements.

7. Achievements & Trophies

  • Users earn achievements for reaching milestones.
  • Admins can create custom trophies for unique accomplishments.

8. Advanced Features

Smart Post Ranking Algorithm

  • Automatically highlights the best posts based on karma, engagement, and recency.

API & Webhooks

  • ReadX provides REST API endpoints for integration with external services.

9. Ongoing Updates

ReadX is continuously developed with new features and improvements. Keep your script up-to-date by downloading the latest versions from the official website.

10. Support

For assistance, contact our support team via [email protected] or visit our help center.

Update

This documentation will be updated as new features are introduced.