Docs

[nelsonic]

We need to build out this project ahead of opening @home so that we have a systematic way of tracking the books. The first step is updating the docs so that we can be help new people wanting to contribute to the App can do so effectively.

@ZooeyMiller & @finnhodgkin made a good start on "whiteboarding" the architecture. #8
We need to export the schema diagram so that people can understand the DB model visually.
Ideally the UX flow should be immediately obvious so anyone can understand it,
but we should still document it so that we have a reference point.

Todo

Document the current:

• What Features are working?
• UX Flow
• DB Schema
  • Entity Relationship Diagram
• Dependencies used
  • https://github.com/dwyl/elixir-auth-github

[nelsonic]

ER Diagram:

[nelsonic]

Guessing that the reasoning behind having author_books be a many-to-many

library/lib/library/books/author.ex

Line 8 in 8dda00a

many_to_many :book, Library.Books.Book, join_through: "author_books"

Is because a book can have several authors e.g: https://www.epicreads.com/blog/ya-books-multiple-authors this makes sense, but it's not documented anywhere in the readme ... 🤔