Design Documents

[darreneid]

Wiki Home Page

• [x] Is the first page you see upon entering the wiki
• [ ] 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)
• [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

    ---

    Database Schema

• [ ] Contains correct datatypes
• [ ] Contains appropriate constraints/details
  • [ ] primary key
  • [ ] not null
  • [ ] unique
  • [ ] indexed
  • [ ] 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!
• [ ] State's keys are camelCased
• [x] All keys within the values in the state are accessible in the schema
• [x] Correctly formatted
  • [ ] 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
  • [ ] entities
  • [ ] session
  • [ ] errors (here or in ui)
  • [ ] 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

• [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
• [ ] 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
• consider allowing one business to have multiple types (or tags), in which case you would need a joins table
• can always add more columns to the user table at a future point if you build out a profile page feature, for example
• probably want to store lat/lng data for each business in order to make rendering on a map easier
• likely need a reviews table, unless that's what you mean when you say comments
• probably don't need a get '/api/users' route
  • we can fetch the relevant user information when we fetch comments
• probably don't need a get '/api/comments' route
  • we can fetch relevant comment info when we fetch a business
• search feature (including location) should utilize business index route