Design Docs

[siascone]

Wiki Home Page

• [x] Is the first page you see upon entering the wiki
• [x] Contains a welcome message
• [ ] Contains a link/placeholder for a link to the live page
• [ ] All links in the right sidebar should contain each wiki page and link to the correct page
• [ ] Correctly formatted
  • [ ] each wiki page is listed in bullet points
  • [ ] all links route the correct page

---

MVP List

• [x] Should have 7 MVPs.
  • [x] 3 of those are User Auth, Heroku, and Production README.
  • [ ] The other 4 are from the Approved Apps List or your PM will have clarified them with you
• [ ] 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
• [ ] Correctly formatted
  • [ ] MVPs are listed in an ordered list
  • [x] Each MVP is broken down into bullet points

---

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

---

Sample State

• [ ] State shape is flat!
• [ ] State's keys are camelCased
• [ ] All keys within the values in the state are accessible in the schema
• [ ] 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
  • [ ] Top level slices
  • [ ] entities
  • [ ] session
  • [ ] errors (here or in ui)
  • [ ] ui (if needed)
  • [ ] 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

---

Backend Routes

• [ ] Contains the following sections: HTML, API Endpoints(Backend)
• [ ] Each route has a description
• [ ] 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

---

Frontend Routes

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

[siascone]

Notes:

• For all notes reference the Bluebird Wiki

Wiki Home page:

• Add live link place holder. Markdown looks like this [MVP List]()
• Add links to design doc pages as bullets. Mark down looks like - [Feature List](MVP-List)
  • For the link in the () just give the name of the wiki page as it appears in the url and GitHub will do the rest

MVP List

• This is a great start and ambitious outline for 2 weeks. Let's narrow the scope a bit
  • The first 7 features should be an ordered list
  • Those 7 should be in the following order
  • 1. Hosting
  • 2. New account creating, login, and guest/demo login
  • 3. Restaurant Listings
       • This includes menus
  • 4. Ordering (i.e Cart)
  • 5. Search
  • 6. Reviews/Ratings
  • 7. Production Readme
  • All others can go under a Bonus heading
• Add a Description sentence of the app

Database Schema

• Looks good

Sample State

• Looking good.
• the key of phone_number should be camelCased to phoneNumber
• Edit the file to include js after the first set of triple backtics so that the code block is colorized to a javascript object

Backend Routes

• Looking good
• Carts does not have a corresponding table in the DB. Could be akin to Orders
  • no need to nest carts under user as a user and cart can be associated i.e. user_instance.cart or cart_instance.user
• all routes should be triple backticked i.e. GET /api/orders
• the GET route for a specific order is missing a wild card of :order_id
• Consider adding edit options for Reviews

Frontend routes

• Very thorough
• I like the seperation of routes and related components from the full component hierarchy
  • To maintain convention, make the bullet of Frontend Routes a heading the same size as `Components
• All routes and components should be backticked