elf
/
notesmachine
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
notesmachine/server/nm-store
History
Elf M. Sternberg 3068f18f0c STYLE Clippified. 
After running 'cargo clippy,' a few changes were made, and then some
were reverted.  Honestly, 'x.len() > 0' is WAY more readable than
'!x.is_empty()'.  The exclamation mark gets swallowed up by the
surrounding text and is hard to see.
 		2020-11-12 15:02:45 -08:00
..
docs Apparently updated some docs. 2020-11-12 07:27:45 -08:00
experiments Reverse reference SQL written. 2020-10-29 10:50:31 -07:00
src STYLE Clippified. 2020-11-12 15:02:45 -08:00
.gitignore DOC Phase one committed to the project, the basic layout of the backstore. 2020-09-27 05:35:37 -07:00
Cargo.toml MERGE Shrinkwrap and Comrak updates. 2020-10-13 18:03:12 -07:00
Makefile DOC Rustfmt works. 2020-09-29 08:08:30 -07:00
README.org Note/Page reference relationships now built. 2020-10-16 07:16:57 -07:00
clippy.toml STYLE Clippified. 2020-11-12 15:02:45 -08:00

README.org

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 connect two notes

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