Proposal Feedback

[evhumphrey]

Wiki Page Home

• [x] Is the first page you see upon entering the wiki
• [x] Contains a welcome message
• [x] Contains a link/placeholder for a link to the live page
• [x] All links in the right sidebar should contain each wiki page and link to the correct page
• [x] Correctly formatted
  • [x] each wiki page is listed in bullet points
  • [x] all links route the correct page

Comments

Great job on the proposal, things are looking good! I left some feedback in this big checklist. You can check things off on this list as you go through it (GitHub will persist the state of the check). ☑️

---

MVP List

• [x] Should have 7 MVPs.
  • [x] 3 of those are User Auth, Heroku, and Production README.
  • [x] The other 4 are from the MVP List or they have clarified them with you
• [x] Contains a description sentence of the app
• [x] Includes two to three detailed bullets on functionality and presentation of feature
• [x] At least one CRUD feature, which states what CRUD operations are planned (creation, reading, updating, deletion)
• [x] Estimates how long it will take the code each MVP
• [x] Correctly formatted
  • [x] MVPs are listed in an ordered list
  • [x] Each MVP is broken down into bullet points

---

Database Schema

• [x] Contains correct datatypes
• [x] Contains appropriate constraints/details
  • [x] primary key
  • [x] not null
  • [x] unique
  • [x] indexed
  • [x] foreign key
• [x] Contains bullet points after the table that state which foreign keys will reference to which table, or references to the associations which will be made
  • [x] foreign key and table name are lowercased, snake_cased and back_ticked
• [x] Correctly formatted
  • [x] schema is written in a table format
  • [x] the table's name are lowercased, snake_cased and back_ticked
  • [x] the table header column names are bolded
  • [x] columns names are lowercased and snaked_cased and back_ticked

Comments

• [x] In your shopping_carts table, a column like checked_out might be useful so you have a way of view past orders (not part of MVPs), and the current pre-check-out cart

---

Sample State

• [x] State shape is flat!
• [x] State's keys are camelCased
• [x] All keys within the values in the state are accessible in the schema
• [x] Correctly formatted
  • [x] Sample state is rendered with triple backticks, and the language ```javascript...```). This will display the state as a code block instead of a giant line of text
  • [x] Top level slices
    • [x] entities
    • [x] session
    • [x] errors (here or in ui)
    • [x] ui (if needed)
  • [ ] Should NOT have nested slices, aka comments inside of posts
    • Some info from other tables is ok, for instance:
    • the author username and imageurl for a post. basically any info that the user can't change
    • like count and a boolean on whether the user likes the post instead of a likes slice

Comments

• [ ] I'd recommend avoiding having arrays of ids for these parts of hour statestate: in books -> reviews (you can instead loop thru reviews and check for a specific book id), and in contentCreators -> createdBooks.

---

Backend Routes

• [x] Contains the following sections: HTML, API Endpoints(Backend)
• [x] Each route has a description
• [x] API Endpoint routes contains wildcard variables written in snake_case
• [ ] Routes does not contain [superfluous routes] (https://github.com/appacademy/curriculum/blob/master/rails/readings/routing-part-ii.md)
• [ ] Have API routes that will allow the front end to get all info it needs and does not have unneeded routes:
  • probably doesn't need a GET likes api endpoint because that info comes through the post show

Comments

• [x] Many of the users routes you may not need, as you can fetch a lot of this information when you're fetching the current user (like their wishlist, library, current shopping cart)
• [x] Might not need GET /api/books/:bookId/reviews if you fetch this info when you fetch a book.

• [x] For the user POST routes, you can omit the user id (you should only be able to create a wishlist for the current user)

Frontend Routes

• [x] Frontend routes contains wildcard variables written in camelCase
• [x] Correctly formatted
  • [x] Routes are displayed with inline coding text (backticks)

[mschl0ss]

Updated schema to include explicit foreign key notes. One of the things I want to talk about in the first meeting is high level shopping cart strategy, so I'm going to hold off on messing with that table until then.

[mschl0ss]

I simplified the backend routes. I'll wait to check with you before I check the boxes.

[mschl0ss]

Updated mvp list to reflect two days for books/category, one day for search.

[mschl0ss]

Several updates to backend routes

• Removed extra route for book reviews (will be fetched with book)
• Removed wildcard from most user routes (eg post to library, wishlist). These will automatically post to current user.
• Changed GET route for category/books to be an api/category route instead of api/books/:catId/books
• ...maybe some other things I'm forgetting. But I definitely did them...if I did them.