Design Docs

[jenvomo]

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

• Let's separate out messages & channels for MVPs so that mvp isn't so big. We can combine DM to be the messages functionality & dm

---

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

• We'll likely want a channel_id for the channel_messages table

---

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

• We'll also want a channelId for each of the channelMessages here

---

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

• [x] We'll want routes for channels to be created, etc

Frontend Routes

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

Comments

• [x] We'll probably want a frontend route for the selected channel someone is on so that the channel show component knows what channel to render. Maybe something like /client/:channelId
• Looks like we have the right idea for the last couple of routes just need to update the formating & include the components:
  • /channels
    • ChannelIndex
  • /channels/:channelId
    • MessageIndex
      • MessageIndexItem
    • MessageForm

[lilyzhaoyilu]

All, except routes, are updated based on the comments. Thanks!

[lilyzhaoyilu]

Front routes & back routes are updated based on suggestions. Changed schema -- now channels table has a column message_id. Now when fetching channelMessages, the server hits channels first and the fetch channelMessages based on message_id column. Not sure if this is a better approach, but the intention is to reduce the number of query requests.

[lilyzhaoyilu]

updated schema to simplified to logic for demo purpose:

• merged direct_messages and channel_messages now all messages are located in messages

Not sure about the backend routes design yet...

[jenvomo]

Just reviewed! Docs are looking great @lilyzhaoyilu ! There a couple items left - let me know if you have any questions!

[lilyzhaoyilu]

updated according to the suggestion above.

[jenvomo]

Great job @lilyzhaoyilu !