notdone

command module
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: Sep 7, 2023 License: MIT Imports: 18 Imported by: 0

README

notdone

Tiny grouped checklists ( as a daemon )

Note: Only works on *nix systems

TOC

Installation

  1. Download a release for your system from the releases → page.

  2. Place the binary wherever you wish to, it'll be easier to access if you place it somewhere accessible by your system

$ mkdir -p ~/.local/bin

$ install notdone ~/.local/bin

# modifiy `PATH` to include the above path
$ echo "export PATH=$HOME/.local/bin:$PATH" >> ~/.bashrc
# or if you use zsh
$ echo "export PATH=$HOME/.local/bin:$PATH" >> ~/.zshrc

# reload your shell's environment
source ~/.bashrc
# or
. ~/.zshrc
  1. Start the daemon by running notdone
$ notdone
  1. You should now be able to access notdone in your browser at localhost:3000

Configuration

Note: Configuration for notdone is stored in ~/.notdone/config.json

key description default
port The port at which notdone runs on 3000

Daemon Control

Reload config
$ notdone -s reload
Stop / Terminate notdone
$ notdone -s quit
# or
$ notdone -s stop

FAQ

Why daemon?
  • Faster that a desktop apps
  • Easier to cross compile (at least when not targeting Windows)
Where's my data!!?

It's all stored in ~/.notdone/storage.json, you can parse and modify the json with any other software if you wish to. Write your own GUI for it, no biggies

License

MIT

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