Skip to content

README.md

Latest commit

 

History

History
83 lines (56 loc) · 2.39 KB

README.md

File metadata and controls

83 lines (56 loc) · 2.39 KB
Raw

Redmine GTT FIWARE Plugin

The Geo-Task-Tracker (GTT) FIWARE plugin adds support for interacting with FIWARE:

  • Create and publish FIWARE Context Broker subscriptions (NGSIv2 and NGSI-LD)
  • Create and update issues based on FIWARE context data
  • Publish issues back to a broker as NGSI-LD entities
  • See and react to other organizations' work on the same entity
  • Manage subscriptions over Redmine's REST API

Requirements

Redmine GTT FIWARE requires PostgreSQL/PostGIS and will not work with SQLite or MariaDB/MySQL!!!

Installation

To install Redmine GTT FIWARE plugin, download or clone this repository in your Redmine installation plugins directory!

cd path/to/plugin/directory
git clone https://github.com/gtt-project/redmine_gtt_fiware.git

Then run

bundle install
bundle exec rake redmine:plugins:migrate

After restarting Redmine, you should be able to see the Redmine GTT FIWARE plugin in the Plugins page.

More information on installing (and uninstalling) Redmine plugins can be found here.

How to use

Detailed instructions on how to use the plugin and its API endpoints can be found in the documentation.

Development

Run the Ruby test suite from the Redmine root, against a PostGIS test database (CI runs the same suites across Redmine 6.0 to 7.0, see .github/workflows/test-postgis.yml):

bundle exec rails test plugins/redmine_gtt_fiware/test/unit
bundle exec rails test plugins/redmine_gtt_fiware/test/functional

The subscription form's JavaScript has its own Vitest suite, runnable from the plugin directory without a Redmine installation:

npm ci
npm test

Contributing and Support

The GTT Project appreciates any contributions! Feel free to contact us for reporting problems and support.

Version History

See all releases with release notes.

Authors

LICENSE

This program is free software. See LICENSE for more information.