Wiki / Proposal

[ajansel]

Wiki Page Home

• 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:

• The link to routes from the bulleted route on the main page isn't linked to the correct page
• Otherwise just add a welcome message and you are in good shape!

---

MVP List

• Should have 7 MVPs.

  • 3 of those are User Auth, Heroku, and Production README.
  • The other 4 are from the MVP List or they have clarified them with you

• Contains a description sentence of the app

• 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

• Each App specific MVP needs the following bullet points are added:

  • Adequate styling
  • Smooth, bug-free navigation
  • Seeded with info to demonstrate this feature

• Correctly formatted

  • MVPs are listed in an ordered list
  • Each MVP is broken down into bullet points

Comments:

• See checkboxes above and BlueBird as an example

---

Database Schema

• Contains correct datatypes

• Contains appropriate constraints/details

  • primary key
  • not null
  • unique
  • indexed
  • 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

• Correctly formatted

  • schema is written in a table format
  • the table's name are back_ticked
  • the table header column names are bolded
  • columns names are lowercased and snaked_cased and back_ticked

Comments:

• You will likely want a username and img_url for a user, price and img_url for an event
• For a ticket I don't think you will need a host_id or order_id but I would have a quantity, type, and price
  • Let's talk some more about this in our 1-on-1
• You will want a bookmarks table that is a joins table between a user and an event
• I would add a unique constraint on category titles and event title

---

Routes

• Routes accurately reflect MVPs and Component Hierarchy
• Covers the frontend functionality of the site through routes that match to the wireframes
• Contains the following sections: HTML, API Endpoints(Backend), and Frontend Routes
• Each route has a description
• API Endpoint routes contains wildcard variables written in snake_case
• Frontend routes contains wildcard variables written in camelCase
• 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 bc that info comes through the post show
• Correctly formatted
  • Routes are displayed with inline coding text (backticks)

Comments:

• Make sure to use : instead of # in your routes
• Make sure to have a new frontend route for events as well
• You will need a patch for events
• Let's revisit tickets after our 1-on-1 tomorrow
• We need backend routes for bookmarks
• Make sure to add a HTML route that routes to your root

---

Sample State

• State shape is flat!
• State's keys are camelCased
• All keys within the values in the state are accessible in the schema (Ex: if you create a imgUrl key in the state, make sure your database also has a column that contains an img_url)
• 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:

• Make sure to add an errors and ui slice of state
• Update your sample state once you have a chance to fix your schema

---

Component Hierarchy with Wireframes

• All routes listed in the routes wiki page is also listed in the component hierarchy
• Each component, if necessary, has route, state, and other components it renders example
• Necessary components are wrapped in a container
• Correctly formatted
  • Bullet point hierarchy
  • Component names are displayed with inline coding text (backticks)
• Wireframes included
  • Every component listed in the component hierarchy wiki page has at least one wireframe
  • Every MVPs listed on the MVP wiki page has at least one wireframe
  • Every route listed on the route wiki page has at least one wireframe
  • Contains Containers
  • Contains multiple Index/List
  • Contains multiple IndexItems/ListItems
  • Correctly formatted
    • Wireframe images display on the page
    • Every wireframe has a header title

Comments:

• You also need a page that is the user's profile so that they can see the events that they have bought tickets for (both upcoming and in the past) as well as events they have bookmarked
• Let's chat some more about the containers and components during our 1-on-1
• Make sure to add what route is rendering what diagram and to list what state it will need access to

[Nenry]

-Completed almost everything until component hierarchy.
-Component hiearchy has more details. More updates to come after 1 on 1

[Nenry]

-Wireframes redone and added

[Nenry]

Remaining issues that were discussed have been resolved