PrestaChamps Module Hub Documentation

Getting Started

The platform provides instant access to all PrestaChamps modules with no login required. Here's how to get started:

1. Search for modules: Use the predictive search bar on the home page to find modules by name, description, or developer
2. Browse by category: Explore modules organized into 10+ categories (Payment, SEO, Security, etc.)
3. Filter by quality: Use security status and validation score filters to find high-quality modules
4. Check module details: View comprehensive information including security status, validation scores, and releases
5. Download: Click the download button to get the latest release or browse all versions

Browsing Modules

The platform offers multiple ways to discover modules:

Predictive Search

Type in the search bar to get instant results as you type. The search looks through module names, descriptions, and developer names. Use keyboard arrows to navigate results and Enter to select.

Advanced Filtering

On the Modules page, use the sidebar filters to narrow down results:

• Search Filter: Text-based search within filtered results
• Category Filter: Filter by module category (Payment, SEO, Marketing, etc.)
• Developer Filter: Show only modules from specific developers
• Security Status: All / Secure (no vulnerabilities) / Has Vulnerabilities / Critical Issues
• Validation Scores: Excellent (80-100) / Needs Improvement (50-79) / Failed (0-49)
• Sort Options: By Name (alphabetical) / By Stars (popularity) / By Recently Updated

Module Cards

Each module card displays:

• Security Indicator: Shield icon showing vulnerability count (or green checkmark if secure)
• Validation Indicator: Colored dot showing code quality (green = excellent, yellow = needs improvement, red = failed)
• Categories: Color-coded category badges
• Version: Latest release version number
• Developer(s): Avatar and name of module creators
• Last Updated: Time since last update

Security System (Technical Deep-Dive)

The platform employs a triple-layer security scanning system to detect vulnerabilities in modules. All modules are automatically scanned daily for security issues.

PHPStan Code Quality Validation (Technical Deep-Dive)

PHPStan is a static analysis tool for PHP that finds bugs in code without running it. The platform uses PHPStan Level 5 to analyze code quality and assign scores to modules.

{
  "totals": {
    "errors": 42,
    "file_errors": 15
  },
  "files": {
    "classes/Product.php": {
      "errors": 3,
      "messages": [
        {
          "message": "Call to undefined method Product::getPrice()",
          "line": 45,
          "ignorable": false
        }
      ]
    }
  }
}

PrestaShop Standards Validation (Technical Deep-Dive)

The PrestaShop Standards Validator ensures modules follow best practices and meet quality requirements for distribution. This validator performs an 8-point checklist.

Email Subscriptions

Subscribe to module updates to receive email notifications when new releases are published.

How to Subscribe

1. Navigate to a module detail page
2. Find the "Get Notified of New Releases" card in the sidebar
3. Enter your email address
4. Click "Subscribe"
5. Check your email for verification link (required)
6. Click the verification link to activate subscription

Email Notifications

You'll receive emails when:

• A new release is published for the module
• Emails include module name, version, release notes, and download link
• Each email contains a one-click unsubscribe link

Unsubscribing

Click the "Unsubscribe" link at the bottom of any notification email. You'll be immediately unsubscribed and receive a confirmation email.

Discord Webhooks

Discord webhook integration allows automated notifications to Discord channels when module events occur.

Supported Events

• new_module: When a new module is added to the hub
• new_release: When a module publishes a new release
• module_update: When module metadata is updated

Webhook Configuration (Admin Only)

Administrators can configure webhooks in the admin panel:

1. Navigate to Admin → Discord Webhooks
2. Click "Create Webhook"
3. Enter webhook name, Discord webhook URL, and description
4. Select event types to monitor
5. Choose modules to track (or select all)
6. Click "Test Webhook" to verify connectivity
7. Save the webhook

Webhook Payload

Discord messages include rich embeds with:

• Module name and description
• Version number (for releases)
• Download link
• GitHub stars count
• Categories
• Timestamp

Developer Attribution

The platform provides proper credit to module developers with professional presentation.

Developer Profiles

Each developer has a dedicated profile page showing:

• Developer avatar (circular, professional)
• Name, website, and email
• Complete list of their modules
• Module count and statistics

Avatar System

Developers can upload custom avatars (JPG, PNG, GIF, max 2MB). Avatar sizes:

• 80px - Developer profile header
• 64px - Admin edit view
• 32px - Module detail sidebar
• 24px - Module header
• 20px - Module list cards
• 16px - Developer grid

Multiple Developers

Modules can have multiple developers. All developers are credited with their avatar and name on module cards and detail pages.

Module Syncing Process

The platform automatically syncs modules from GitHub daily to keep information up-to-date.

Automated Sync Schedule

The sync process runs daily via scheduled command (modules:sync). It:

1. Fetches all repositories from the PrestaChamps GitHub organization
2. Compares latest release with local database
3. Skips if already synced (same latest release)
4. Downloads new metadata if updates detected
5. Syncs releases and download assets
6. Runs security scans (triple-layer)
7. Runs PHPStan code quality validation
8. Runs PrestaShop standards validation
9. Triggers Discord webhooks and email notifications

What Gets Synced

• Module name, description, and metadata
• GitHub stars, forks, watchers, and open issues
• License information (SPDX ID)
• README content
• Repository topics (for categorization)
• Latest commit timestamp
• All releases and their assets (ZIP files)
• Developer attribution (repository owner)

Manual Override Protection

If metadata_manually_modified flag is set to true, the sync preserves:

• Module name and slug
• Short description
• Display name
• Long description

Only statistics and content (README, releases) are updated.

Admin Panel

The admin panel provides full control over modules, developers, categories, webhooks, and email settings.

Admin Access

Navigate to /admin and log in with admin credentials. The admin panel is protected by Laravel's authentication guard.

Available Management Sections