Design Docs and Wiki

[siascone]

Wiki Home Page

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

Comments

---

MVP List

• [x] Should have 7 MVPs.
  • [x] 3 of those are User Auth, Heroku, and Production README.
  • [ ] The other 4 are from the MVP List or your PM will have clarified them with you.
• [ ] Contains a description sentence of the app
• [ ] Includes two to three detailed bullets on functionality and presentation of feature
• [ ] 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 MVP
• [ ] Correctly formatted
  • [x] MVPs are listed in an ordered list
  • [x] Each MVP 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
• [ ] 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
• [ ] Correctly formatted
  • [x] schema is written in a table format
  • [ ] 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

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

Comments

---

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

Comments

---

Frontend Routes

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

Comments

[siascone]

Things to consider/edit/add

Main Wiki Page

• Add a placeholder for a live link [Yep](live link will go here)
• Add links to all design doc pages
• Checkout Bluebird for reference

MVP List

• looking good.
• MVPs 3-6 should be the following in this order:
  3. Business Page
  4. Search/Filters
  5. Reviews/Ratings - CRUD
  6. Map - Google Maps
• make each mvp a heading using '#', '##', '###' etc for different sized headings
• Checkout Bluebird for reference

Database Schema

• Looks like a good start. the Users table is looking good. Take a look at the Bluebird database schema to check for difference and get ideas for your Restaurants, Reviews, Likes etc tables

Sample state

• Checkout the Bluebird sample state for reference

Backend Routes

• Checkout the Bluebird backend routes for reference

Frontend Routes

• Checkout the Bluebird frontend routes for reference

Let me know if you have any questions. Please get the missing pages at least started before tomorrow morning.

[nilshen]

Thanks Spencer, I will work on these now!

On Thu, Jun 16, 2022 at 3:43 PM Spencer Iascone @.***> wrote:

Things to consider/edit/add

Main Wiki Page

• Add a placeholder for a live link [Yep](live link will go here)
• Add links to all design doc pages
• Checkout Bluebird https://github.com/appacademy/bluebird/wiki for reference

MVP List

• looking good.
• MVPs 3-6 should be the following in this order:
  3. Business Page
  4. Search/Filters
  5. Reviews/Ratings - CRUD
  6. Map - Google Maps
• make each mvp a heading using '#', '##', '###' etc for different sized headings
• Checkout Bluebird https://github.com/appacademy/bluebird/wiki/mvp-list for reference

Database Schema

• Looks like a good start. the Users table is looking good. Take a look at the Bluebird https://github.com/appacademy/bluebird/wiki/schema database schema to check for difference and get ideas for your Restaurants, Reviews, Likes etc tables

Sample state

• Checkout the Bluebird https://github.com/appacademy/bluebird/wiki/sample-state sample state for reference

Backend Routes

• Checkout the Bluebird https://github.com/appacademy/bluebird/wiki/backend-routes backend routes for reference

Frontend Routes

• Checkout the Bluebird https://github.com/appacademy/bluebird/wiki/frontend-routes frontend routes for reference

Let me know if you have any questions. Please get the missing pages at least started before tomorrow morning.

— Reply to this email directly, view it on GitHub https://github.com/nilshen/Yep/issues/1#issuecomment-1158066393, or unsubscribe https://github.com/notifications/unsubscribe-auth/AXMQ74VA6V5KN5KDRD4IOHTVPN7UTANCNFSM5YK75TNA . You are receiving this because you are subscribed to this thread.Message ID: @.***>