Design Docs Checklist

[samwalker191]

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

    ---

    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

    ---

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

    ---

    Sample State

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

      ---

      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

    ---

    Frontend Routes

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

    Comments

[samwalker191]

MVP List Comments:

• [ ] See above checklist for missing stuff.
• [ ] I would recommend the MVP list to be the following MVPs:
  • Listings
    • Users can view all available listings
    • Clicking on listing redirects to the corresponding show page
    • Listing show page has booking form and shows listing details
  • Bookings
    • Logged-in users can book a spot through booking form
    • User can view their bookings via profile page
    • User can cancel their bookings via profile page
    • Listings Search / Google Maps
    • Users can search spots by geographical location
    • User can search by date range for available listings
    • Reviews
    • Listing detail (show) page displays reviews
    • Logged in users can write listings reviews
    • Logged in users can delete their listing reviews

[samwalker191]

Schema Comments:

• [ ] Reservations table might need some dates for when the reservation takes place.
• [ ] See above checklist for some missing stuff. Mainly formatting.

[samwalker191]

Sample State Comments:

• [ ] The likes slice has a body key but that is not in the schema.
• [ ] The names on these sample data are 🔥
• [ ] See checklist above for missing stuff.

[samwalker191]

Backend Routes Comments:

• [ ] Make sure the routes are backticked. Ex: GET /api/users