📦 How to Install a Module in PhPstrap

Modules let you extend your app with new features. Follow these steps to install one through the admin panel.

âś… Step 1: Upload the Module

  1. Download the module from GitHub or the PhPstrap Marketplace.
  2. Unzip the downloaded file.
  3. Upload the folder to your server’s /modules/ directory.
    e.g., /your-app-root/modules/example-module/
Note: The module must include a valid module.json file in its root directory.

âś… Step 2: Open the Admin Module Library

Navigate to the /admin/modules page. You’ll see something like this:

PhPstrap Module Library interface

âś… Step 3: Scan for Modules

Click the 🔍 Scan for Modules button.

  • PhPstrap will look for new module folders in /modules/.
  • If a valid module is found, it will appear in the list.

âś… Step 4: Enable and Install

  1. Click + Install Module.
  2. Confirm and proceed through any module-specific setup prompts.
  3. Once installed, the module will move to the Installed Modules tab.

🛠️ Troubleshooting

  • Module doesn’t appear? Check that module.json exists and has valid JSON syntax.
  • Install fails? Review your PHP error logs or ensure the module is compatible with your PhPstrap version.

Need help? Join the community on GitHub.