Design Docs

[darreneid]

Wiki Home Page

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

• looks good

  MVP Feature List

• [x] Should have 7 total features
  • [x] 3 of those are User Auth, Hosting, and Production README.
  • [x] The other 4 are unique to the specific app
• [x] Contains a description sentence of the app
• [x] Includes two to three detailed bullets on functionality and presentation of feature
• [x] Two CRUD features
• [x] Estimates how long it will take the code each feature
• [x] Correctly formatted
  • [x] Features are listed in an ordered list
  • [x] Each feature is broken down into bullet points

    Comments

• Are remarks essentially posts? if so that's definitely the place to start
• I'm curious how you settled upon upvotes/likes, as Nextdoor also has reactions/comments/shares
• Let's combine user profiles and search into one feature and not do search for remarks just yet
• Move follows up into your core features

  • Is this equivalent to "Connect" on Nextdoor?

    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

• The users table doesn't need a column for storing a profile pic (will use AWS instead)
• What is worldID?
• Is a remark text only?
• Can comments be nested? If so we need a parent_comment_id column
• Nice use of polymorphic relationship for upvotes

• Need table for follows/friends if we're making that a core feature

  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

    Comments

• Probably need to store information on ordering comments and remarks

• Need slice of state for follows/friends/connections if we're making that a core feature

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

  Comments

• Will need CRUD routes for follows if we make that a core feature
• Not sure we need separate routes for retrieving a user's followers and followed users
  • Can always grab that info when retrieving a user
• In general I'm not a huge fan of nested API routes because we can always use query string params but it's not a big deal
• I assume we're fetching upvotes when retrieving a upvoteable entity?

• Initially not sure we need a separate route for fetching comments, but if we're dealing with a lot of data it might make sense

  Frontend Routes

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

    Comments

• Don't need a separate component for demo login, most likely
• Remember that this is meant to be a clone - you can mostly just copy frontend routes by poking around Nextdoor

[darreneid]

Actually it looks like the new post form on Nextdoor is a modal

[harivmasoor]

great catch sir! so Schema wouldn't change but this would be superflous routes for sure. I will fix now

[harivmasoor]

that's correct right? just update the routes and not schema?

[harivmasoor]

NVM - I see the comments now, will work through and report back

[harivmasoor]

Updated feature list to include connections - renamed to likes, reaction, and shares. Schema - removed prof picture and worldID functionality(not sure if I will get to it), added image and location to remakrs, added parentcommentid, added a connections table. Sample state updated to reflect. consolidated routes in backend. Removed remarks routes on frontend as they are dealt as modals. LMK if the second pass looks good!

[harivmasoor]

just updated backend routes to use query string and removed all nested routes