FSP Design Docs To-do List

[Carly-Schaaf]

FSP Design Docs

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 the following list for the 4 app specific MVPs:
  • [x] Adequate styling
  • [x] Smooth, bug-free navigation
  • [x] Adequate and appropriate seeds to demonstrate the 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

• Looks good, although I would encourage you to move your CRUD trading/watchlist feature up to the top, to at least #4 if not #3

---

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] Correctly formatted
  • [x] schema is written in a table format
  • [x] the table's name are back_ticked
  • [x] the table header column names are bolded
  • [x] columns names are lowercased and snaked_cased and back_ticked

Comments

• Looks great!

• [x] You may want to add an account_balance column on the users table, and consider how to deal with users having different currency types, unless everyone deals in gold?

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

• Perfect.

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

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

Comments

• I think you want to add some components to display the user's watchlist and relevant news articles

[guptaloop]

Hey @Carly-Schaaf , I made the following updates to my design docs:

• Schema

  • remove email column from users table
  • add gold column to users table
  • remove holdings table
  • add watchedStocks table

• Sample State updated to reflect Schema changes

• MVP List

  • swapped features 4 & 5
  • I kept the Asset/Stock Detail feature at #3 since that will include the bulk of my data seeding and make the watchlist feature easier to build on top

• Backend Routes

  • remove holdings routes
  • add watchedStocks routes

• Frontend Routes

  • remove holdings routes / containers
  • add watchlist routes / containers
  • add newsfeed routes / containers