Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 3.46 KB

README.md

File metadata and controls

49 lines (31 loc) · 3.46 KB
Raw

BIIGLE Module Template

Test status

This is a template that can be used for the development of new BIIGLE modules.

How to develop BIIGLE modules

The BIIGLE manual contains some tutorials that can get you started with BIIGLE module development. This repository implements the code that is covered in the first three tutorials.

How to use this template

First, create a new repository based on this template. Then update the name of this module from biigle/module to whatever name you want to use for your module. The name has to be updated at the following locations:

  1. QuotesController.php
  2. index.blade.php#L13
  3. index.blade.php#L16
  4. ModuleServiceProvider.php#L21
  5. ModuleServiceProvider.php#L30
  6. ModuleServiceProvider.php#L43
  7. composer.json#L2
  8. test.yml#L15

Next, update the namespace of all PHP classes (Biigle\Modules\Module) and replace Module with the name of your module. Do this in webpack.mix.js#L23, too. Also update this readme for your new module. You should remove the first two subsections and update the installation instructions. Now you can install the module and start developing.

In addition to the code of the tutorials this repository already contains the configuration for Laravel Mix as build system. To install the build system, run and then run npm install. Now you can use the following commands:

  • npm run dev: Builds and publishes the assets once.
  • npm run prod: Builds, minifies and publishes the assets once. Always do this before you commit new code.
  • npm run watch: Continuously builds and publishes the assets whenever an asset file is changed.
  • npm run lint: Run static analysis to check for errors.

Installation

Note that you have to replace biigle/module with the actual name of your module/repository.

  1. Run composer require biigle/module. This requires your module to be published on Packagist. If you don't want to publish your package, read more on alternative options.
  2. Add Biigle\Modules\Module\ModuleServiceProvider::class to the providers array in config/app.php. Replace Module in the class namespace with the name of your module.
  3. Run php artisan vendor:publish --tag=public to refresh the public assets of the modules. Do this for every update of this module.

Developing

Take a look at the development guide of the core repository to get started with the development setup.

Want to develop a new module? Head over to the biigle/module template repository.

Contributions and bug reports

Contributions to BIIGLE are always welcome. Check out the contribution guide to get started.