Design Documents

[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

    ---

    Feature List

• [x] Should have 7 Features.
  • [x] 3 of those are User Auth, Heroku, and Production README.
  • [x] The other 4 are unique to this project
• [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)
• [ ] 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

    ---

    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

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

[darreneid]

I've gone through the above checklist above, meaning anything left unchecked is missing or incomplete.

Notes:

• change name of MVP List to Feature List
• more detailed description of the app at the top of the Feature List page would be great
• are you planning on utilizing any map API for visualizing businesses?
• might want to add a has_many association between users and businesses
• what is the reasoning for the rated column in the list_items table?
  • ideally don't want to update multiple tables when creating a review, for example
• add uniqueness constraint to ratings table that restricts a user from reviewing the same business twice
• store lat/lng data in businesses table to simplify rendering to map
• what are yelp_rating and bean_rating columns?
• consider has_many :followers association (or similar) for each business
• need a get '/api/session' route for retrieving session info and syncing our frontend
• don't need dedicated route for creating a business if it's happening internally
• don't need a dedicated route for updating business info
  • do it from within the post '/api/ratings' route
• likely don't need dedicated route for viewing lists if it's already happening on the home page