Create a Plugin
To create a Workarea plugin, use the rails plugin new command with a Workarea plugin template.
$ rails plugin new path/to/my_plugin --full -m path/to/plugin_template.rb --skip-spring --skip-active-record --skip-action-cable
This template can be found in the workarea repository at https://github.com/workarea-commerce/workarea/blob/master/plugin_template.rb.
After creating the plugin, edit the gemspec file to set relevant plugin meta data.
Plugins may be developed within their own git repository or as part of an existing repository, such as a host application built on the Workarea platform. If developing the plugin within an existing repository, be sure to change the s.files
logic within the gemspec to include only files relevant to the plugin. For example, Dir.glob
over a given array of directory globs rather than including all files with git ls-files
.
Help Us Improve this Doc
Was this helpful? Open a GitHub issue to report a problem with this doc, suggest an improvement, or otherwise provide feedback. Thanks!