notesmachine/server/nm-store/README.org

• Notesmachine Store
  • Plans
    • Make it possible to save a note
    • Make it possible to retrieve a note
    • Read how others use SQLX to initialize the database
    • Implement CLI features
    • Make it possible to connect two notes
    • Make it possible to save a page
    • Make it possible to connect a note to a page
    • Make it possible to retrieve a collection of notes
    • Make it possible to retrieve a page

Notesmachine Store

This is the storage layer for Notesmachine. It supports the retrieval of the basic information from Notesmachine, but it never reveals the underlying mechanisms by which it performs its magic. The "ids" leaving this API will always be the textual ids used in all public representations:

• Boxes are referenced by slugs, and clients must accept uniqueness failures.
• Notes are referenced by "friendly_id" format strings, which are base-62 formatted versions of UUID4 strings.

Plans

TODO Make it possible to save a note

TODO Make it possible to retrieve a note

TODO Read how others use SQLX to initialize the database

TODO Implement CLI features

TODO Make it possible to connect two notes

TODO Make it possible to save a page

TODO Make it possible to connect a note to a page

TODO Make it possible to retrieve a collection of notes

TODO Make it possible to retrieve a page