PA Review: Design Docs

[kkossally]

Wiki Page Home

• [x] Is the first page you see upon entering the wiki
• [x] Contains a welcome message
• [ ] 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

• Add a bulleted list of the pages in your wiki.

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

Comments

• Call Access User Auth.
• Don't nest bullet points (for readability).
• Images is an example of something you can add to a collage, not a separate MVP.
• Private Collages is a feature of Collages, not a separate MVP.
• Notifications is a feature of a Follows MVP.
• Be more explicit about the CRUD features of your app.
• Add a Profile MVP.

• Add a Production README MVP.

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
  • [ ] foreign key and table name are lowercased, snake_cased and back_ticked
• [ ] Correctly formatted
  • [x] schema is written in a table format
  • [ ] the table's name are lowercased, snake_cased and back_ticked
  • [x] the table header column names are bolded
  • [ ] columns names are lowercased and snaked_cased and back_ticked

Comments

• users.session_token should be indexed.
• You can just say creator_id references users.

• Foreign keys should be indexed.

Sample State

• [x] State shape is flat!
• [ ] 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)
  • [x] 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

• Change errors.signIn to errors.session since it should hold both signup and login errors.

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
• [x] Routes does not contain superfluous routes
• [x] 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

• These routes will likely need a few updates when you update your MVP list.

Frontend Routes

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

Comments

[kkossally]

MVP List

• [ ] Be more explicit about your CRUD features

  Sample State

• [ ] Description should be lowercase