"create-mirador-plugin" scaffold package

ProjectMirador / mirador

An open-source, web-based 'multi-up' viewer that supports zoom-pan-rotate functionality, ability to display/compare simple images, and images with annotations.

https://projectmirador.org

Apache License 2.0

548 stars 258 forks source link

"create-mirador-plugin" scaffold package #2201

Open charbugs opened 5 years ago

charbugs commented 5 years ago

A scaffold package for creating mirador plugins, similar to create-react-app. May contain:

mirador
webpack, webpack-cli
webpack.config.js
example plugin code

The config files should define mirador and react as peer dependencies so that these packages won't be bundled in the plugin.

aeschylus commented 5 years ago

https://github.com/facebook/create-react-app/blob/master/tasks/cra.js Adapting☝️could be a good starting place.

charbugs commented 5 years ago

Ok, will have a look.

mejackreed commented 5 years ago

I'm not sure how far down we want to go here.. For #1985 I did this:

nwb new react-component mirador-image-tools

And then a smallish commit got me most the way there.

https://github.com/mejackreed/mirador-image-tools/commit/27208e24c3a470bed67816852fc8375c06ca3f31

charbugs commented 5 years ago

:+1:

I think the peer dependency thing may not be obvious at first glance for contributers. So a scaffold package could preconfigure the packacke-json that way.