Design Docs To-Do List

[mwmadsen67]

Wiki Page Home

• [ ] 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

---

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
• [ ] 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
• [ ] Correctly formatted
  • [ ] MVPs are listed in an ordered list
  • [ ] Each MVP is broken down into bullet points

---

Database Schema

• [x] Contains correct datatypes
• [ ] Contains appropriate constraints/details
  • [x] primary key
  • [ ] not null
  • [x] unique
  • [ ] indexed
  • [x] foreign key
• [ ] 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
  • [ ] foreign key and table name are lowercased, snake_cased and back_ticked
• [ ] Correctly formatted
  • [ ] schema is written in a table format
  • [ ] the table's name are lowercased, snake_cased and back_ticked
  • [ ] the table header column names are bolded
  • [ ] columns names are lowercased and snaked_cased and back_ticked

---

Sample State

• [ ] State shape is flat!
• [ ] State's keys are camelCased
• [ ] All keys within the values in the state are accessible in the schema
• [ ] Correctly formatted
  • [ ] 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
  • [ ] Top level slices
    • [ ] entities
    • [ ] session
    • [ ] errors (here or in ui)
    • [ ] 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

---

Backend Routes

• [ ] Contains the following sections: HTML, API Endpoints(Backend)
• [ ] Each route has a description
• [ ] API Endpoint routes contains wildcard variables written in snake_case
• [ ] Routes does not contain superfluous routes
• [ ] 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

---

Frontend Routes

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

[mwmadsen67]

Hi Brian, I'm going to leave some feedback on your design docs here. Feel free to ask questions in this thread if you have any.

MVP List:

• formatting should be improved to match our examples
• each MVP needs a description of what it entails and an estimated finish time
• search/filters is not a CRUD feature
• reviews is a CRUD feature, and I would say should come after the business MVP
• I would be happy to meet and talk about planning this and prioritizing which features to work on first

Schema:

• users looks good
• you do not need to index phone numbers or geolocations
• You should spend more time looking at the business page to see what information youll need to store. you will likely need columns for things like price, hours, and description for example
• reviews dont need a title column, but they do need ratings
• there are no likes on yelp, if you want to mark reviews as useful / funny / cool then thats a bonus MVP and you dont need to include it in your schema for now

Sample State: :(

Backend Routes:

• all of your users routes should be plural
• GET /api/users would a user index, which is not a yelp feature. if you want a user show, it should be GET /api/user/:id
• im not sure what delete and patch food collection is, and I dont know why its under users backend routes
• restaurant routes look good, but youll need to add a route for business search
• you need to write routes for reviews

Frontend Routes:

• the current routes looks good
• you should have a frontend route for a user show page