Scope Gemfile.local gem to development group only

README.md

@@ -1,2 +1,29 @@
 # openproject-dev_tools
-OpenProject plugin adding tools helping with local development of OpenProject
+
+OpenProject plugin adding tools helping with local development of OpenProject.
+
+## Installation
+
+To include this plugin in your OpenProject installation, add the following to a `Gemfile.local` file in your OpenProject root directory:
+
+```ruby
+group :development do
+  gem "openproject-dev_tools", git: "https://github.com/opf/openproject-dev_tools.git", branch: "main"
+end
+```
+
+If you have checked out the plugin locally, you can reference the local path instead:
+
+```ruby
+group :development do
+  gem "openproject-dev_tools", path: "/path/to/openproject-dev_tools"
+end
+```
+
+After adding the gem, run the following from your OpenProject root directory to install the plugin:
+
+```bash
+bundle install
+```
+
+Then restart your OpenProject server.

lib/open_project/dev_tools.rb

@@ -0,0 +1,5 @@
+module OpenProject
+  module DevTools
+    require "open_project/dev_tools/engine"
+  end
+end

lib/open_project/dev_tools/engine.rb

@@ -0,0 +1,18 @@
+# Prevent load-order problems in case openproject-plugins is listed after a plugin in the Gemfile
+# or not at all
+require 'active_support/dependencies'
+require 'open_project/plugins'
+
+module OpenProject::DevTools
+  class Engine < ::Rails::Engine
+    engine_name :openproject_dev_tools
+
+    include OpenProject::Plugins::ActsAsOpEngine
+
+    register(
+      'openproject-dev_tools',
+      :author_url => 'https://openproject.org',
+      :requires_openproject => '>= 13.1.0'
+    )
+  end
+end

lib/open_project/dev_tools/version.rb

@@ -0,0 +1,5 @@
+module OpenProject
+  module DevTools
+    VERSION = "1.0.0"
+  end
+end

lib/openproject-dev_tools.rb

@@ -0,0 +1 @@
+require 'open_project/dev_tools'

openproject-dev_tools.gemspec

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'open_project/dev_tools/version'
+
+Gem::Specification.new do |s|
+  s.name        = "openproject-dev_tools"
+  s.version     = OpenProject::DevTools::VERSION
+  s.authors     = ["OpenProject GmbH"]
+  s.email       = "info@openproject.org"
+  s.homepage    = "https://github.com/opf/openproject-dev_tools"
+  s.summary     = 'OpenProject Dev Tools Plugin'
+  s.description = "An OpenProject plugin adding tools helping with local development of OpenProject"
+  s.license     = "GPLv3"
+
+  s.files = Dir["{app,config,db,lib}/**/*"] + %w(README.md)
+end