Usage Guide - SteffenBlake/TaskBud GitHub Wiki

Task Groups

Task Groups are the top level object for TaskBud, and are used as a means for organizing tasks into reasonable areas. Some examples of Task Groups you may want to make:

  • Shopping List
  • To-Do List
  • Reminders
  • Groceries

Creating

Creating Task Groups is restricted to Administrators only. To create a new Task Group, simply navigate to Tasks > + Create New

Tasks (Index Page)

The index page for Tasks is located at the root of your website, or /Index, both work. This page shows a list of all tasks

  1. Task Group Title
  2. Task Assignee
  3. Created Time/Priority
  4. Plaintext short Description, truncated
  5. Assignee
  6. Swipe left to mark as complete. Swipe Right to Assign to self (if no assignee), or Unassign (if assigned to you)
  7. Expanded Info (click on a task to expand it)
  8. Assign (expanded)
  9. Description, full markdown rendered
  10. Edit button
  11. History (Undo/Redo functionality)
  12. Create New Task

Functionalities

  • Swipe Tasks Left to mark as complete.
  • Swipe a Task to the right to:
    • If Assigned to you, unassign it so others can see it
    • If unassigned, to claim it and assign it to yourself
  • Changes to tasks automatically propagate to other users. When you claim a task, others see the result instantly without needing to refresh their browsers!
  • Click on a task to expand it and see its expanded description and edit button.

Create or Edit a Task

  • Description supports markdown. Markdown guide here: https://www.markdownguide.org/cheat-sheet/
  • Wait Until: Task will not show up until this date
  • Repeat: Setup a Cron Repeat Task via a popup editor
    • Starter Assignee: Who the Assignee will be set to when the task repeats. 'None' is a valid option here.
    • When a Repeating task is completed, rather than being actually completed, it instead gets its Wait Until date updated to be the next valid date and time matching the Cron repeat you set.
    • IE: If you set a Task to repeat on the First of each month and its Starter Assignee to 'Sally', and it gets completed on March 20th, it will then get its Wait Until date reset to April 1st (Which is the next valid match for 'First of each month'), and Sally will get it assigned to her regardless of who completed the task prior.
  • If Assignee is set to None, all users will be able to see the Task, and anyone can claim it

History Manager

Nearly all actions that you perform on TaskBud will get logged into the History Manager. Simply Swipe left on any of these to 'Undo' them. Once Undone, you can swipe left again to Redo them.