todo
is a Go 1.16
based cli tool and REST api that will scan a directory for Markdown files that contain Markdown format TODO items and serve them up to read and manipulate them via cli and eventually a full CRUD REST interface.
# will scan this directory for Markdown files
# if it finds todo's it will print them out
todo -d ~/Dropbox/notes
- setup project
- read active todos and spit them out to cli
- setup makefile
- setup github actions for ci unit tests
- publish test badges in readme
- setup cli parsing
- mark a todo as done via cli
- investiage ncurses interface
- Create build and release pipeline
- Create docker container
- restructure code like https://github.com/pokemium/Worldwide
- create an http interface
- create GET (active) collection
- create PUT/PATCH item to mark todo as done
- create DELETE item
- create POST to collection
- Create docker container
- Following the project layout Go project layout standard
- Focus on CLI functionality first, then work on REST interface+
# debugging
go run ./cmd/todo
# running tests
(cd pkg/scan && go test)
## Licence
[MIT](LICENCE)