|
| 1 | +# Redmine Geo-Task-Tracker (GTT) Plugin |
| 2 | + |
| 3 | +The Geo-Task-Tracker (GTT) plugin adds spatial capabilities to Redmine: |
| 4 | + |
| 5 | +- Locate your issues as point, line or polygon |
| 6 | +- Show and filter issues on a map |
| 7 | +- Specify a project area |
| 8 | +- Store the location of a user |
| 9 | +- Extends Redmine API |
| 10 | +- Geocoding |
| 11 | +- and more |
| 12 | + |
| 13 | +## Project health |
| 14 | + |
| 15 | +[TBD] |
| 16 | + |
| 17 | +## Requirements |
| 18 | + |
| 19 | +Redmine GTT plugins **require PostgreSQL/PostGIS** and will not work with SQLite or MariaDB/MySQL!!! |
| 20 | + |
| 21 | +- Redmine >= 3.4.0 |
| 22 | +- PostgreSQL >= 9.6 |
| 23 | +- PostGIS >= 2.4 |
| 24 | + |
| 25 | +## Installation |
| 26 | + |
| 27 | +Create a PostGIS-enabled database: |
| 28 | + |
| 29 | +``` |
| 30 | +createdb -U postgres -O redmine redmine |
| 31 | +psql -U postgres -d redmine -c "CREATE EXTENSION postgis;" |
| 32 | +``` |
| 33 | + |
| 34 | +To install Redmine GTT plugin, download or clone this repository in your Redmine installation plugins directory! |
| 35 | + |
| 36 | +``` |
| 37 | +cd path/to/plugin/directory |
| 38 | +git clone https://github.com/gtt-project/redmine_gtt.git |
| 39 | +``` |
| 40 | + |
| 41 | +Then run |
| 42 | + |
| 43 | +``` |
| 44 | +bundle install |
| 45 | +bundle exec rake redmine:plugins:migrate |
| 46 | +``` |
| 47 | + |
| 48 | +After restarting Redmine, you should be able to see the Redmine GTT plugin in the Plugins page. |
| 49 | + |
| 50 | +More information on installing (and uninstalling) Redmine plugins can be found here: http://www.redmine.org/wiki/redmine/Plugins |
| 51 | + |
| 52 | +## How to use |
| 53 | + |
| 54 | +[Settings, screenshots, etc.] |
| 55 | + |
| 56 | +## Contributing and Support |
| 57 | + |
| 58 | +The GTT Project appreciates any [contributions](https://github.com/gtt-project/.github/blob/main/CONTRIBUTING.md)! Feel free to contact us for [reporting problems and support](https://github.com/gtt-project/.github/blob/main/CONTRIBUTING.md). |
| 59 | + |
| 60 | +## Version History |
| 61 | + |
| 62 | +[TBD] |
| 63 | + |
| 64 | +## Authors |
| 65 | + |
| 66 | + - [Jens Kraemer](https://github.com/jkraemer) |
| 67 | + - [Daniel Kastl](https://github.com/dkastl) |
| 68 | + - [Thibault Mutabazi](https://github.com/eyewritecode) |
| 69 | + - [Ko Nagase](https://github.com/sanak) |
| 70 | + - ... [and others](https://github.com/gtt-project/redmine_gtt/graphs/contributors) |
| 71 | + |
| 72 | +## LICENSE |
| 73 | + |
| 74 | +This program is free software. See [LICENSE](LICENSE) for more information. |
0 commit comments