PHPackages biigle/module - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. biigle/module ActiveLibrary[Utility & Helpers](/categories/utility) biigle/module ============= A template for a new BIIGLE module. v1.4.0(1y ago)07.8kGPL-3.0-onlyPHPCI passing Since Aug 21Pushed 2w ago2 watchersCompare [ Source](https://github.com/biigle/module)[ Packagist](https://packagist.org/packages/biigle/module)[ Docs](https://biigle.de)[ RSS](/packages/biigle-module/feed)WikiDiscussions main Synced 1w ago READMEChangelog (5)DependenciesVersions (12)Used By (0) BIIGLE Module Template ====================== [](#biigle-module-template) [![Test status](https://github.com/biigle/module/workflows/Tests/badge.svg)](https://github.com/biigle/module/actions?query=workflow%3ATests) This is a template that can be used for the development of new BIIGLE modules. How to develop BIIGLE modules ----------------------------- [](#how-to-develop-biigle-modules) The BIIGLE manual contains [some tutorials](https://biigle-admin-documentation.readthedocs.io/module-development/module-development/) 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 ------------------------ [](#how-to-use-this-template) First, [create a new repository](https://github.com/biigle/module/generate) (either private or public) based on this template. Development & Development Installation ------------------------------------------ [](#development--development-installation) Clone the module to a local directory. The name of this module needs to be updated in several locations. For your convenience, we provide a PHP script to automate this process. Run `php setup.php YourModuleName` to update all locations at once. The name must start with an uppercase letter and may only contain letters and digits (e.g. `MyModule`). If your module is not (yet) published on Packagist, you need to add the following to biigle's composer.json (found in the BIIGLE root directory; if repositories already exist, add the new one to the list): ``` "repositories": [ { "type": "vcs", "url": "git@github.com:/" } ] ``` If the repository is private you need to have ssh-keys configured for your GitHub account. Run `composer require biigle/:dev-main --ignore-platform-reqs` in the BIIGLE root directory to install the module to BIIGLE. Note that Composer identifies the package by the `name` in its composer.json (which `setup.php` sets to `biigle/` in lowercase), not by the repository URL. Still in the BIIGLE root directory run `php artisan vendor:publish --tag=public`. The module is now installed to `biigle/vendor/biigle/`. You can go there and develop your module. Run `npm install` once to set up the build system. Then you can use the following commands: - `npm run dev`: Continuously builds the assets during development. - `npm run build`: Builds, minifies and publishes the assets once. - `npm run lint`: Run static analysis to check for errors. Also update this readme for your new module. You should remove the first three subsections and update the installation instructions. And don't forget to change the author and GitHub address in `composer.json` as well. Installation ------------ [](#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](https://packagist.org/). If you don't want to publish your package, read more on [alternative options](https://getcomposer.org/doc/05-repositories.md#vcs).* 2. Run `php artisan vendor:publish --tag=public` to refresh the public assets of the modules. Do this for every update of this module. Developing ---------- [](#developing) Take a look at the [development guide](https://github.com/biigle/core/blob/master/DEVELOPING.md) of the core repository to get started with the development setup. Want to develop a new module? Head over to the [biigle/module](https://github.com/biigle/module) template repository. Contributions and bug reports ----------------------------- [](#contributions-and-bug-reports) Contributions to BIIGLE are always welcome. Check out the [contribution guide](https://github.com/biigle/core/blob/master/CONTRIBUTING.md) to get started. ### Health Score 47 — FairBetter than 93% of packages Maintenance72 Regular maintenance activity Popularity23 Limited adoption so far Community12 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor1 Top contributor holds 72.8% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~519 days Total 5 Last Release 476d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/2457311?v=4)[Martin Zurowietz](/maintainers/mzur)[@mzur](https://github.com/mzur) --- Top Contributors [![mzur](https://avatars.githubusercontent.com/u/2457311?v=4)](https://github.com/mzur "mzur (110 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (37 commits)")[![dlangenk](https://avatars.githubusercontent.com/u/4822085?v=4)](https://github.com/dlangenk "dlangenk (3 commits)")[![lehecht](https://avatars.githubusercontent.com/u/72259845?v=4)](https://github.com/lehecht "lehecht (1 commits)") --- Tags biiglebiigle-modulebiiglebiigle-module ### Embed Badge ![Health badge](/badges/biigle-module/health.svg) ``` [![Health](https://phpackages.com/badges/biigle-module/health.svg)](https://phpackages.com/packages/biigle-module) ``` ### Alternatives [prewk/option Option object for PHP inspired by Rust 47971.9k2](/packages/prewk-option) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)