notesmachine/server/nm-store
Elf M. Sternberg 4e04bb47d5 FEAT: Reference parser is now working.
It's probably not the fastest thing in the world, but
it's going to be enough for now.
2020-10-13 17:23:24 -07:00
..
docs Not working. 2020-10-06 08:01:25 -07:00
src FEAT: Reference parser is now working. 2020-10-13 17:23:24 -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 FEAT: Reference parser is now working. 2020-10-13 17:23:24 -07:00
Makefile DOC Rustfmt works. 2020-09-29 08:08:30 -07:00
README.org DOC Phase one committed to the project, the basic layout of the backstore. 2020-09-27 05:35:37 -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 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