Files
snotes/DESCRIPTION.md
2026-09-26 20:46:49 -07:00

2.0 KiB

snotes (SchmeeveNotes)

A simple hosted notes app which features:

  • Simple markdown output to a filesystem (which will be a mounted NAS, not local disk, so performance key)
  • Features a rich text editor
  • Picks up tags Twitter style, I can just end a note in #recipe and that's picked up as a tag
  • Front page features most-used tabs, search, and recent entries
  • Allows local access (192.168.1.1/24) with no password, remotely needs a password set via .env
  • Theme styles ala $HOME/git/tasky or $HOME/git/schmeeviVerse
  • Modern design, consider adopting $HOME/git/m8-cuetool/docs/Hyper_v5.5.0
  • History on notes at least recording time/date and IP/machine name
  • User spaces, so I can have my notes, Ilya can have his, etc; cookied upon selection so each re-entry to the site picks automatically
  • Common shared user space for all

Notes

  • This is a new project, no existing code yet
  • The main image (and favicon) is in assets/snotes-main.png
  • Arch using Flask is fine, unless you can suggest something better
  • Will be deployed as a docker container on the ppv.loc box (ssh root@ppv.loc will let you look)
  • The mount used for notes will be /mnt/aura/snotes on the ppv.loc box

DOs

  • Ask Questions
  • Verify as you go
  • Write tests

DONTs

  • Cowboy code
  • Make assumptions
  • Go YOLO

CLI

snotes TUI app

  • new CLI page on webapp gives instructions on installing the CLI: bash http://sno.tes/[user]/cli, the user allows the script to be customized upon download with both the userspace and the URL, such config is saved to ~/.config/snotes
  • snotes command alone opens TUI with list, new options, pane with most recent notes, search, like webapp
  • snotes [template] [date] opens a template dated [date]
  • templates are defined like tags but using $ notation, so $journal in the note defines a journal template
  • Template will have variable replacements, so if the first like is something like # Journal for %date%, the date [date] is inserted
  • snotes recent shows a list of notes along with search
  • snotes find (term) opens the search interface