Skip to content

Plugin that adds spatial capabilities to Redmine

License

Notifications You must be signed in to change notification settings

nobnisai/redmine_gtt

 
 

Repository files navigation

Redmine Geo-Task-Tracker (GTT) Plugin

CI #develop

The Geo-Task-Tracker (GTT) plugin adds spatial capabilities to Redmine:

  • Locate your issues as point, line or polygon
  • Show and filter issues on a map
  • Specify a project area
  • Store the location of a user
  • Extends Redmine API
  • Geocoding
  • and more

Requirements

Redmine GTT plugins require PostgreSQL/PostGIS and will not work with SQLite or MariaDB/MySQL!!!

  • Redmine >= 4.0.0
  • PostgreSQL >= 9.6
  • PostGIS >= 2.4
  • NodeJS v14
  • yarn

Installation

Create a PostGIS-enabled database:

createdb -U postgres -O redmine redmine
psql -U postgres -d redmine -c "CREATE EXTENSION postgis;"

To install Redmine GTT 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.git
cd redmine_gtt
yarn
npx webpack

Then run

export GEM_PG_VERSION=your-pg-version # skip this line if redmine use pg 1.2.2.
export GEM_RGEO_ACTIVERECORD_VERSION=your-rgeo-activerecord-version # skip this line if using rgeo-activerecord 6.2.2.
export GEM_ACTIVERECORD_POSTGIS_ADAPTER_VERSION=your-activerecord-postgis-adapter-version # skip this line if using activerecord-postgis-adapter 5.2.3.
bundle install
bundle exec rake redmine:plugins:migrate

Before restarting Redmine, you need to set postgis adapter instead of postgres adapter in your config/database.yml.

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

More information on installing (and uninstalling) Redmine plugins can be found here: http://www.redmine.org/wiki/redmine/Plugins

How to use

  1. Go to plugin configuration for global settings
  2. Configure at least one tile source
  3. Enable GTT module in a project
  4. Define the project boundary in GTT project settings
  5. Create a new issue with a point, line or polygon

For more information with screenshots see the Getting Started guide.

Contributing and Support

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

How to debug frontend

You can debug frontend by running the following command on another console:

npx webpack --watch --mode=development

How to run test

You can run the plugin test on rails test environment by the following command:

bundle exec rake db:create
RAILS_ENV=test bundle exec rake db:migrate
RAILS_ENV=test bundle exec rake redmine:plugins:migrate
RAILS_ENV=test NAME=redmine_gtt bundle exec rake redmine:plugins:test

Version History

See all releases with release notes.

Authors

LICENSE

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

About

Plugin that adds spatial capabilities to Redmine

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 42.9%
  • TypeScript 33.2%
  • SCSS 14.7%
  • HTML 8.3%
  • Other 0.9%