redmine time logging app

this redmine plugin adds a new menu entry and separate section to log and edit ones own spent time in one place, in a quick way.

features

powerful autocomplete that searches projects, issues and versions that accepts word fragments in any order
lists the spent time entries per day and allows to switch fast between days
time entry create/edit/move/copy/delete
overview page that lists the total hours per day, month, and year
a timer that will add elapsed time to the hours and minutes field
link to the selected issue or project
shows individual and everyone's total spent time for issues and projects
automatically skips weekends without time entries
supports project-specific activities
a click into an empty search field suggests issues recently changed by the user
a click on the logged hours or activity opens the redmine time entry list for the issue or project
translatableare any

installation

download

dowload a release or a zip file via github and unpack the archive. alternatively, you can clone the source code repository with "git clone https://github.com/Intera/redmine_time_logging_app.git".

setup

move the "redmine_time_logging_app" directory from the download to your redmine instance directory to "plugins/", so that it lies at "plugins/redmine_time_logging_app"
if the file system permissions are right, the plugin should now be installed
restart redmine
go into redmine under "Administration" -> "Plugins" to check that it is listed

usage

after successful installation, if the current redmine user has the redmine permissions to log time and to edit own time entries, a menu entry "Time Logging" or similar in the topmost navigation bar in redmine should be visible. clicking on the menu entry should open a new browser tab where the time entry editor app appears.

if you have made time entries today, a list of your spent time entries for today is displayed. you can use the left/right arrow buttons at the top left, or the date field and date picker, to change between days.

to create a new spent time entry, use the search field to search and select the desired issue or project, fill in at least a time and activity and click "create".

to edit a time entry, click on the pencil button in the list of time entries. you can change the date freely. when you click on "update" the changes will be saved.

configuration

see "Administration" -> "Plugins" -> "redmine time logging app" -> "Configure".

optionName	default	description
date format	"D d.m.y"	jQuery datepicker format
earliest selectable date	-6m	format
latest selectable date	+0	format
first day of week	1	0-6, sunday to monday
load closed issues of the past n days	7	include closed issues as long as they are not older than the given number of days
warn when exceeding estimated time	off	show a warning when trying to log time that would exceed the estimated time of the issue
disallow logging time on projects	off	redmine allows spent time on issues and projects, this setting allows time entries only on issues

developer information

how to add a new translation language

copy one of the files in "config/locales/" to a new one named with the appropriate language code
edit the file and replace the translations with your translations

the plugin tries to use the language that the user has configured in redmine under "my account" and falls back to english

code development dependencies

nodejs

development setup

execute "npm install" on the command-line to install the required nodejs modules at once (coffeescript, browserify, coffeeify and fs-extra)

interesting files

"app/controllers/time_logging_app_controller.rb" is the backend interface
the javascript code is under "src/js" and written as coffeescript
the main javascript entry point is "js/main.coffee"
src/js/lib/* contains any javascript files that are maintained elsewhere
"src/js/config.coffee" is a configuration file and contains some additional settings that can not be set via the plugin configuration page

how to recompile the javascript application

execute "./exe/compile". should that not work, try "node exe/compile"
changes will only become active after a redmine restart, because redmine installs new plugin assets only when it starts
css and javascript files are compiled into the redmine plugin assets directory

possible enhancements

timer
- remember elapsed seconds. currently only full minutes are logged
- continue logging in the background even when the app page is not open
remove the focus style on buttons on touch devices (trying to fix it by overwriting .ui-state-focus css did not work)

intera / redmine_time_logging_app Goto Github PK