Skip to content
This repository was archived by the owner on Jul 17, 2025. It is now read-only.
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions docs/docs/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,36 +18,36 @@ Before installing a module, ensure that:
Following these steps ensures a smooth installation and management process for OBMS modules. For more details, refer to the module’s official documentation.

1. **Find the Module**
Identify the module you want to install from the official OBMS repositories or Packagist. Each module has a unique package name that can be used for installation.
Identify the module you want to install from the official OBMS repositories or Packagist. Each module has a unique package name that can be used for installation.

2. **Install via Composer**
Run the following command to install a module using Composer:
```
composer require obms/<module-name>
```
Run the following command to install a module using Composer:
```
composer require obms/<module-name>
```

For example, to install the PayPal Payment Gateway module, use:
```
composer require obms/paymentgateway-paypal
```
For example, to install the PayPal Payment Gateway module, use:
```
composer require obms/paymentgateway-paypal
```

3. **Run Migrations (if required)**
Some modules may require database migrations. If specified in the module’s documentation, run:
```
php artisan migrate
```
Some modules may require database migrations. If specified in the module’s documentation, run:
```
php artisan migrate
```

4. **Enable the Module**
Depending on the module type, it may need to be activated within the OBMS admin panel or via the command line. Check the module documentation for specific activation instructions.
Depending on the module type, it may need to be activated within the OBMS admin panel or via the command line. Check the module documentation for specific activation instructions.

5. **Clear Cache**
After installation, clear your application cache to ensure the module loads correctly:
```
php artisan config:clear
```
```
php artisan cache:clear
```
After installation, clear your application cache to ensure the module loads correctly:
```
php artisan config:clear
```
```
php artisan cache:clear
```

### Updating Modules
To update an installed module to the latest version, run:
Expand Down Expand Up @@ -85,4 +85,4 @@ The Module SDK offers a comprehensive set of tools and documentation for develop
### Composer Installer
To manage module installations efficiently, OBMS utilizes a custom Composer Installer. This tool automates the installation and updating of modules, ensuring they are correctly integrated into the OBMS environment. The Composer Installer's source code and usage instructions are available on [GitHub](https://github.com/OBMS-Open-Business-Management-Software/composer-installer).

For more detailed information on module development and integration, developers are encouraged to consult the [OBMS Developer Documentation](/docs/developer_guide/intro).
For more detailed information on module development and integration, developers are encouraged to consult the [OBMS Developer Documentation](/developer_guide/intro).
You are viewing a condensed version of this merge commit. You can view the full changes here.