Instructions/best practices for development of plugins using this template

[fraxen]

Hi,
It would be great if we could set up some wiki pages or expand on the readme on how to develop plugins using this template, and then update and keep in sync - for e.g. bug fixes for the overall architecture and framework updates. Is it even possible?

I guess I could clone (or fork) this repo, then add my own plugin code as git submodules in the same way as app1-3 are there, but once I start to modify fw1config.cfm then that breaks the compatibility with the master MuraFW1 repo...

[fraxen]

The problem with this repo is that it is both a plugin framework and a template. I think the way to go would be to add this repo as a submodule to a plugin and have the plugin Application.cfc etc extend/include the code from this repo. Would need to check that it works! Paths etc might be messed up...

[stevewithington]

@fraxen thanks for the suggestions. i've thought about having a separate MuraFW1Lite project that doesn't include any of the subapplications before ... so maybe, i'll do something like that. i've flagged this as an enhancement and will give it some more thought.

[stevewithington]

@fraxen to address your question about trying to keep your plugin updated and in sync, that's not really the intent for this plugin. this plugin is mainly a "template" ... it's something you start off with, and then modify to suit your needs. i would think of it like the MuraBoostrap theme ... you wouldn't want to use it out of the box, you'd want to customize it. same applies here. also, when you build an actual plugin for production, it's usually constructed and then left alone with minor maintenance along the way ... so it diverges from the template right away. hope that makes sense.

that said, i've updated the plugin with the latest FW/1 and DI/1 code, and made some minor adjustments to keep it working.

i'm still considering a MuraFW1Lite and will probably get to that soon.

[fraxen]

I had an idea of creating a bare template that includes this repo as a submodule, so that one could update that separately and get any modifications that way (updates of FW1 and edits for Mura versions). Then one could start developing from the template (cloning first) and update this repo separately.