Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/biigle/module

:m: A template for a new BIIGLE module

https://github.com/biigle/module

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary

Keywords

biigle biigle-module

Keywords from Contributors

labels
Last synced: 10 months ago · JSON representation

Repository

:m: A template for a new BIIGLE module

Basic Info
  • Host: GitHub
  • Owner: biigle
  • License: gpl-3.0
  • Language: PHP
  • Default Branch: main
  • Homepage:
  • Size: 2.31 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 4
Topics
biigle biigle-module
Created almost 7 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.md

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: 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.

  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.

Owner

  • Name: BIIGLE
  • Login: biigle
  • Kind: organization
  • Location: Bielefeld University

GitHub Events

Total
  • Release event: 1
  • Delete event: 3
  • Issue comment event: 1
  • Push event: 4
  • Pull request event: 7
  • Create event: 4
Last Year
  • Release event: 1
  • Delete event: 3
  • Issue comment event: 1
  • Push event: 4
  • Pull request event: 7
  • Create event: 4

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 54
  • Total Committers: 3
  • Avg Commits per committer: 18.0
  • Development Distribution Score (DDS): 0.259
Top Committers
Name Email Commits
Martin Zurowietz m****n@z****e 40
dependabot[bot] 4****]@u****m 9
Martin Zurowietz m****r@u****m 5
Committer Domains (Top 20 + Academic)
zurowietz.de: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 0
  • Total pull requests: 27
  • Average time to close issues: N/A
  • Average time to close pull requests: 13 days
  • Total issue authors: 0
  • Total pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.11
  • Merged pull requests: 24
  • Bot issues: 0
  • Bot pull requests: 23
Past Year
  • Issues: 0
  • Pull requests: 7
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 month
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.29
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 6
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (30)
  • mzur (3)
  • lehecht (2)
Top Labels
Issue Labels
Pull Request Labels
dependencies (30) javascript (3)

Packages

  • Total packages: 1
  • Total downloads:
    • packagist 6,223 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
packagist.org: biigle/module

A template for a new BIIGLE module.

  • Homepage: https://biigle.de
  • License: GPL-3.0-only
  • Latest release: v1.4.0
    published about 1 year ago
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 6,223 Total
Rankings
Downloads: 17.3%
Dependent packages count: 19.1%
Forks count: 24.6%
Average: 25.4%
Stargazers count: 32.6%
Dependent repos count: 33.5%
Maintainers (1)
mzur
Funding
Last synced: 11 months ago

Dependencies

package-lock.json npm
  • 794 dependencies
package.json npm
  • @mzur/laravel-mix-artisan-publish ^1.0.0 development
  • cross-env ^5.1 development
  • eslint ^7.3.1 development
  • eslint-plugin-vue ^7.0.0 development
  • laravel-mix ^6.0.13 development
  • resolve-url-loader ^5.0.0 development
  • sass ^1.15.2 development
  • sass-loader ^8.0.0 development
  • vue-loader ^15.9.6 development
  • vue-template-compiler ^2.6.11 development
.github/workflows/lint.yml actions
  • actions/checkout v1 composite
.github/workflows/test.yml actions
  • actions/checkout v1 composite