https://github.com/enet4/generator-dicoogle-webplugin

A Yeoman generator for Dicoogle web UI plugin projects
https://github.com/enet4/generator-dicoogle-webplugin

dicoogle haktoberfest yeoman-generator

Last synced: about 2 months ago
JSON representation

A Yeoman generator for Dicoogle web UI plugin projects

• Host: GitHub
• URL: https://github.com/enet4/generator-dicoogle-webplugin
• Owner: Enet4
• License: mit
• Created: 2015-12-26T18:32:18.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-09-01T10:51:05.000Z (4 months ago)
• Last Synced: 2024-10-12T02:14:57.481Z (2 months ago)
• Topics: dicoogle, haktoberfest, yeoman-generator
• Language: JavaScript
• Homepage:
• Size: 1.56 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# generator-dicoogle-webplugin [![npm version](https://badge.fury.io/js/generator-dicoogle-webplugin.svg)](https://badge.fury.io/js/generator-dicoogle-webplugin) [![Node.js CI](https://github.com/Enet4/generator-dicoogle-webplugin/actions/workflows/node.js.yml/badge.svg)](https://github.com/Enet4/generator-dicoogle-webplugin/actions/workflows/node.js.yml)

> A Yeoman generator for Dicoogle web UI plugin projects.

Since version 2.1.0 of [Dicoogle](https://github.com/bioinformatics-ua/dicoogle), the user interface can be extended with plugins that are dynamically loaded into the web page. Please see the [Web UI Plugins section of the Dicoogle Learning Pack](https://bioinformatics-ua.github.io/dicoogle-learning-pack/docs/webplugins/) and the [Dicoogle Webcore Readme](https://github.com/bioinformatics-ua/dicoogle/tree/master/webcore#creating-plugins) for more information on how to create your own plugins.

## Installation

First make sure that yeoman is globally installed. If not:

    npm install -g yo

Then, install the generator (also globally):

    npm install -g generator-dicoogle-webplugin

## Usage

Create a directory for the web UI plugin project and run the generator on it:

    mkdir webplugin-project # or your directory name of choice

    cd webplugin-project

    yo dicoogle-webplugin

Then simply follow the instructions. The generated project will contain a README file with building and deployment instructions.

## License

MIT