Skip to content

Install Module

Jump to bottom
Lenny P. edited this page Aug 2, 2024 · 1 revision

Install Module

This guide will walk you through the process of installing a module for CyanFox Base. Follow the steps below to successfully add and enable the module.

Step-by-Step Instructions

  1. Navigate to the CyanFox Base Directory

First, ensure you are in the CyanFox Base directory.

cd /var/www/CyanFox-Base
  1. Create a Modules Directory and Navigate Into It

Create a modules directory if it doesn't already exist, and then navigate into it.

mkdir modules && cd modules
  1. Download the Module

Download the module using wget. Replace the URL with the appropriate module download link if necessary.

wget https://github.com/CyanFox-Projects/CyanFox-Base-Modules/releases/download/2024-08-01-228a93e/DashboardModule.zip
  1. Unzip the Module

Unzip the downloaded module.

unzip DashboardModule.zip
  1. Remove the Zip File

Remove the zip file to clean up the directory.

rm DashboardModule.zip
  1. Navigate Back to the CyanFox Base Directory

Go back to the CyanFox Base directory.

cd ..
  1. Update Composer's Autoloader

Run Composer to update the autoloader.

composer dump-autoload
  1. Enable the Module

Enable the module using Artisan. Replace DashboardModule with the name of the module you are installing if different.

php artisan module:enable DashboardModule
  1. Run Database Migrations

Run the database migrations required by the module.

php artisan migrate

Conclusion

You have successfully installed and enabled the DashboardModule for CyanFox Base. Repeat these steps for any additional modules you wish to install.

Clone this wiki locally