https://github.com/theunraveler/taskwarrior-web

A web interface for the Taskwarrior todo application. Because being a neckbeard is only fun sometimes.
https://github.com/theunraveler/taskwarrior-web

Last synced: 2 months ago
JSON representation

A web interface for the Taskwarrior todo application. Because being a neckbeard is only fun sometimes.

• Host: GitHub
• URL: https://github.com/theunraveler/taskwarrior-web
• Owner: theunraveler
• License: mit
• Created: 2011-04-28T07:15:43.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2019-09-09T13:59:17.000Z (over 5 years ago)
• Last Synced: 2024-04-24T16:24:42.318Z (9 months ago)
• Language: Ruby
• Homepage: http://theunraveler.github.com/taskwarrior-web
• Size: 1.29 MB
• Stars: 513
• Watchers: 16
• Forks: 63
• Open Issues: 70
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# A Web Interface for Taskwarrior

A lightweight, Sinatra-based web interface for the

wonderful [Taskwarrior](http://taskwarrior.org/) todo application.

Check out the [Live Demo](http://35.196.114.51).

[![Gem Version](https://badge.fury.io/rb/taskwarrior-web.png)](http://badge.fury.io/rb/taskwarrior-web)

[![Build Status](https://secure.travis-ci.org/theunraveler/taskwarrior-web.png)](http://travis-ci.org/theunraveler/taskwarrior-web)

## Table of Contents

* [Screenshots](#screenshots)

* [Requirements](#requirements)

* [Installation](#installation)

* [Usage](#usage)

* [Features](#features)

* [Docker](#docker)

* [Reporting Bugs](#reporting-bugs)

* [Marginalia](#marginalia)

## Screenshots

### Pending Tasks



### Waiting Tasks



### Completed Tasks



### New Task w/ Project Autocomplete



### Parent Project Information



### Projects Overview



### Help Popup



## Requirements

* `ruby` >= 1.9 (support for `ruby` < 1.9 is very unlikely, but pull requests

  are gladly accepted).

For building native extensions on Linux could be required the following packages:

 * ruby-dev

 * make

 * gcc

## Installation

`gem install taskwarrior-web`

This will install an executable called `task-web`

## Usage

`task-web` at your terminal to start it up. This will start the process,

background it, and open the URL in your browser.

It uses [Vegas](https://github.com/quirkey/vegas/) to make the Sinatra app into

an executable, so all options for Vegas are valid for `task-web`. Type

`task-web -h` for more options.

## Features

The current featureset includes:

* Viewing tasks sorted and grouped in various ways.

* Creating a new task with a due date, project, and tags.

* Editing and deleting tasks (only task >= 2.0).

* `task-web` will pull your `task` config (from `.taskrc`) and use it to

  determine date formatting and when an upcoming task should be marked as

  "due".

* If you are on a Mac and use Fluid.app, you get a dock badge showing the

  number of pending tasks.

* [Optional HTTP Basic authentication][1].

[1]: https://github.com/theunraveler/taskwarrior-web/wiki/Additional-.taskrc-options

## Docker

You can also run taskwarrior-web using docker.

This approach requires [docker](https://www.docker.com) and

[docker-compose](https://github.com/docker/compose) to be installed.

The command below builds new image from the source and runs service.

```sh

make run

```

By default task-web is listening on `5678` port.

Adjust service configuration in `docker/docker-compose.yml`.

## Reporting Bugs

To report a bug, use the [Github issue tracker][2]. Since `taskwarrior-web`

works with several different versions of `task`, using many different

configurations, please include the output from `task _version` and either the

output of `task show` or a copy of your `.taskrc` file when filing a bug. This helps us reproduce bugs easier.

Here is an example of a [good bug report][3].

[2]: http://github.com/theunraveler/taskwarrior-web/issues

[3]: http://github.com/theunraveler/taskwarrior-web/issues/26

## Marginalia

* This project is not developed by the Taskwarrior team. Obviously, taskwarrior-web extends Taskwarrior, but the projects are separate.

* `task-web` is mostly designed to run locally. As such, security is not of the highest priority. You may find that things such as CSRF protection are lacking. If things like this are important to you, please file an issue or a pull request.