togo

README

togo

A TODO app written in Go

Project plan

• Save basic TODO items with a title and description
• Add a due date
• Sort by title
• Sort by due date
• Create a project and associate TODOs with a project
• Add priority levels
• Sort by date or priority + date
• View upcoming TODOs
  • overall
  • per project
• View overdue TODOs
  • overall
  • per project
• Permanent storage
• OpenAPI server and client generation

In-Memory Specifics

• Don't copy tasks into the index, store a pointer

Documentation

Index

• Constants
• type Priority
• type Task
  • func NewTask(name, description string) Task
  • func (t *Task) AddDueDate(due time.Time)
  • func (t *Task) Complete()
  • func (t *Task) CompletionDate() *time.Time
  • func (t *Task) DueOn() *time.Time
  • func (t *Task) IsCompleted() bool
  • func (t *Task) Overdue() bool
• type Tasks
  • func (ts Tasks) Len() int
  • func (ts Tasks) Less(i, j int) bool
  • func (ts Tasks) Swap(i, j int)

Constants

const (
	None   Priority = 0
	Low             = 1
	Medium          = 2
	High            = 3
)

Types

type Priority

type Priority int32

type Task

type Task struct {
	Name        string
	Description string
	Priority    Priority
	Created     time.Time
	Completed   *time.Time
	DueDate     *time.Time
}

func NewTask

func NewTask(name, description string) Task

func (*Task) AddDueDate

func (t *Task) AddDueDate(due time.Time)

AddDueDate strips off the time component and stores the result as the due date

func (*Task) Complete

func (t *Task) Complete()

func (*Task) CompletionDate

func (t *Task) CompletionDate() *time.Time

func (*Task) DueOn

func (t *Task) DueOn() *time.Time

func (*Task) IsCompleted

func (t *Task) IsCompleted() bool

func (*Task) Overdue

func (t *Task) Overdue() bool

type Tasks

type Tasks []Task

func (Tasks) Len

func (ts Tasks) Len() int

func (Tasks) Less

func (ts Tasks) Less(i, j int) bool

func (Tasks) Swap

func (ts Tasks) Swap(i, j int)