caleb1991 / epeolatry_front_end Goto Github PK

If a book is in the reader’s library, the reader will see a button to “Remove from Library.” Clicking this button will remove the book from the reader’s library in the Google Books DB.

• Removing a book from the reader’s library should destroy words added for that book
• Upon deleting the book, the user is redirected to the books index page, where they no longer see this book listed

FE will ping:
DELETE (remove a book from library) / epeolatry API

BE will need:
DELETE (remove a book from library) / Google Books API

If a book is already in the reader’s library, the page renders the book details, any words associated with the book, and a button to lookup a word from that book.

Book’s word list:

• Word, which links to word show page
• Words are shown in order of time added to the list, with most recently added words at the top

Book details:

• Title
• Author
• Genre
• Summary
• Shelf/status
• [Date started?]
• [Date completed?]

FE will ping:
GET (book’s word list) / epeolatry API
GET (get book details and status if in library) / epeolatry API

BE will need:
GET (check if book is in library) / Google Books API
GET (get book details) / Google Books API

If a book is in the reader’s library, the reader can search for a word. On submitting the word search, the search results are shown on the Book Show page (in a “Search Results” section separate from the book’s word list section).

The “Search Results” section shows the first [1 word] resulting from the search, and each word links to that word’s show page.

FE will ping:
GET (lookup word in dictionary) / epeolatry API

BE will need:
GET (lookup word in dictionary) / dictionary API

When a reader is on the Word Index page, they see all of their words listed out in order of most recently added.

• Each word is a link to that word’s Word Show page
• Word attributes shown: date added, book title as link to book show page
• Index page is paginated for multiple words with 20 as their default, reader can adjust for how many they want to see

FE will ping:
GET (reader’s words) / epeolatry API

Upon clicking the “Save Word” button, the user is redirected to the book’s show page where they see that word now listed in the book’s word list (and any search results from the initial word search are cleared)

FE will ping:
POST (add word to the book’s word list) / epeolatry API

The word show page includes:

• The book title from which this word was searched
• The definition of the word
• A button to “Save this word to ’s words”
• Additional word details, e.g.:
  • phonetic pronunciation
  • link to pronunciation
  • example
  • part of speech
  • synonyms
  • language

FE will ping:
GET (lookup word in dictionary) / epeolatry API

BE will need:
GET (lookup word in dictionary) / dictionary API

When a reader is on the Word Index page and they see all of their words, they see on option to filter their list of words by an attribute

• Book’s word list it’s on as link to book’s show page
• Date added
• Alphabetically
• Order of difficulty?

FE will ping:
GET (reader’s words with filters applied) / epeolatry API

Sad path: If a reader removes a book from their library outside of Epeolatry, then when the user visits the Word Index or Word Show pages, the “Book” attribute shows an error that “This word was added for a book that is no longer in your library”

• Book’s Attributes: Title, author, shelf
• Title links to book show page
• Should be paginated

FE will ping: GET (reader’s books) / epeolatry API
BE will need to ping: GET (reader’s books) / Google Books API

• Book’s Attributes: Title, author, shelf
• Title links to book show page
• Should be paginated

FE will ping: GET (reader’s books with filter applied) / epeolatry API
BE will need to ping: GET (reader’s books) / Google Books API

• Average words saved per book
• Most frequently looked up word
• Longest word looked up

GET (reader’s word stats) / Epeolatry API

If a book is not yet in the reader’s library, the page renders the book details and a button to add the book to a shelf.

Book details:

• Title
• Author
• Genre
• Summary
• [Date started?]
• [Date completed?]

Upon clicking the ‘Add Book’ button and selecting a shelf (or defaulting to a specific shelf, TBD based on BE team research), the reader is returned to a refreshed Book Show page where they see options to add a word to the book, and no longer see the option to ‘Add Book’ to a shelf.

FE will ping: GET (get book details and status if in library) / epeolatry API

BE will need:
GET (check if book is in library) / google books API
GET (get book details) / google books API

For a word that is already in the reader's glossary:

The word show page includes:

The book title(s) under which this book is saved
The definition of the word
Additional word details

• phonetic pronunciation
• link to pronunciation
• example
• part of speech
• synonyms

FE will ping:
GET (show word) / epeolatry API

• Search output is shown in a “Search Results” section (separate from the book index)
• Search result title links to book show page
• Search results should be paginated

FE will ping: GET (book search results) / epeolatry API
BE will need: GET (book search results) / Google Books API

• Users must have a Google Account to use Epeolatry
• Reader is directed to dashboard on login

• Dashboard shows a welcome message
• Logged in reader sees log-out button
• Dashboard has link to Books Index
• Dashboard has link to Words Index