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, just need that placeholder link

• Also you have duplicate backend routes documents

  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

• Strongly recommend that core features be:
  1. Server CRUD
  2. Channel CRUD
  3. Messages (and websockets)

  4. User search and friends

     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

• What is a bucket?
• Message needs to be associated with a channel somehow

• Server table probably needs to store a owner or creator id

  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

• Choose between session slice of state and currentUser key in users slice - no need for both

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

  Comments

• Routes for server and channel CRUD
• Need an explanation on what buckets are

• Need a route for message creation

  Frontend Routes

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

    Comments

• After logging in, all frontend routes in Discord are:
  • /channels/:serverId/:channelId

[darreneid]

See above comments