tuna-timer-api

command module
v0.0.0-...-52be0da Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 30, 2017 License: MIT Imports: 12 Imported by: 0

README

Slack Time

Build Status codecov Issue Count

"Slack Time" a simple time tracker for teams that use Slack as their office. Using the tool you and your team members can track time spent on tasks as well as get exhaustive reports.

It leverages a custom slash command for Slack. It helps team members to track times they spend on tasks.

Features

  • Start and stop timer on a task
  • Resume the timer on the last stopped task
  • See what tasks you and other team member are working on currently
  • Flexible reporting:
    • Get aggregated report for given team member for given time frame (this week, last week, this month, last month etc) as a message in a Slack channel
    • Generate a CSV or XLSS report file and post its link to Slack so you can click to download the report

Look and feel

ScreenShot

Quick tour

Start a timer on task

Suppose you post a message like below in #my-project Slack channel:

/timer start create HDPI variant of the logotype

This will create a new task called "Create HDPI variant of the logotype" in my-project project and start timer on it.

What of my tasks has the timer on?

Then later you would like to see what task your timer in on currently:

/timer status

will reply you with this (todo: put a actual image from Slack channel)

Project: my-project     Task: Create HDPI variant of the logotype       Task ID: e4f96c7
User: pavlo             Status: in progress                             Time Spent: 25 minutes
Stop timer on task

Then later you finsh the task by either starting a new one - "Slack Time" will automatically stop the other one if any - or explicitly stop it like this:

/timer stop

which would reply like this:

Project: my-project     Task: Create HDPI variant of the logotype       Task ID: e4f96c7
User: pavlo             Status: completed                               Time Spent: 1:20h

Assumptions and defaults

A team member can only do ONE task at a time. If you start a new one that would stop the one you had a timer on previously.

Basic syntax

How to run the app on your server

It is recommended to use Docker images to run the application.

  • DATABASE_USER
  • DATABASE_PASS
  • DATABASE_HOST
  • DATABASE_PORT
  • DATABASE_NAME

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL