Download the PHP package biigle/module without Composer
On this page you can find all versions of the php package biigle/module. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download biigle/module
More information about biigle/module
Files in biigle/module
Package module
Short Description A template for a new BIIGLE module.
License GPL-3.0-only
Homepage https://biigle.de
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package module
BIIGLE Module Template
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:
QuotesController.phpindex.blade.php#L13index.blade.php#L16ModuleServiceProvider.php#L21ModuleServiceProvider.php#L30ModuleServiceProvider.php#L43composer.json#L2test.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: Starts the development server supporting hot module replacement.npm run build: Builds, minifies and publishes the assets once. Always do this before you commit new code.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.
- 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. - Add
Biigle\Modules\Module\ModuleServiceProvider::classto theprovidersarray inconfig/app.php. ReplaceModulein the class namespace with the name of your module. - Run
php artisan vendor:publish --tag=publicto 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.
