Design Docs Checklist

[samwalker191]

Wiki Page Home

• [ ] Is the first page you see upon entering the wiki
• [ ] Contains a welcome message
• [ ] Contains a link/placeholder for a link to the live page
• [ ] All links in the right sidebar should contain each wiki page and link to the correct page
• [ ] Correctly formatted
  • [ ] each wiki page is listed in bullet points
  • [ ] 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
  • [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

    ---

    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)
  • [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:

Looks 🔥

• [x] I would recommend the order of MVPs to be this: Profile -> Connections -> Posts + Comments -> News Feed
• [x] MVPs with one bullet should have 2-3. Might just have to break the bullet into two if you can, or add a little more description of the MVP

[samwalker191]

Schema Comments:

Looks good!

[samwalker191]

Sample State Schema:

Looks good!

[melflynn]

I've updated the MVPs!

[samwalker191]

Backend Routes Comments:

I think the Get /api/connections route would still be needed, since the full connections info isnt needed on some pages. We dont need to know who all of the current user's connections are when looking at the news feed. However, when someone navigates to the connections page, we need to load all of the connections info. So it might be beneficial to have this route for that reason.

• [x] I think the reactions routes' descriptions still talk about comments :D

[melflynn]

Backend Routes Comments:

I think the Get /api/connections route would still be needed, since the full connections info isnt needed on some pages. We dont need to know who all of the current user's connections are when looking at the news feed. However, when someone navigates to the connections page, we need to load all of the connections info. So it might be beneficial to have this route for that reason.

• [ ] I think the reactions routes' descriptions still talk about comments :D

Updated!

[samwalker191]

Frontend Routes Comments:

Looks great.