elf
/
notesmachine
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
notesmachine/server/nm-store
History
Elf M. Sternberg 72fb3b11ee FEAT Delete & Update note is now complete. 
Well, as complete as it could be without proper automated testing.
I think there'll be some more testing soon, as it doesn't make sense
for it to hang out so blatantly like this.

Both a fmt and clippy pass have shaken all the lint off, and right
now it builds without warnings or lintings.  Wheee!
 		2020-10-26 18:54:56 -07:00
..
docs FEAT Delete & Update note is now complete. 2020-10-26 18:54:56 -07:00
src FEAT Delete & Update note is now complete. 2020-10-26 18:54:56 -07: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

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