Design Docs

[siascone]

Wiki Home Page

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

---

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
• [ ] 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 MVP
• [x] Correctly formatted
  • [x] MVPs are listed in an ordered list
  • [x] Each MVP is broken down into bullet points

---

Database Schema

• [x] Contains correct datatypes
• [ ] Contains appropriate constraints/details
  • [ ] 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
  • [ ] 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
  • [ ] columns names are lowercased and snaked_cased and back_ticked

---

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

---

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 a welcome message to the top of your home page
• Add live link place holder. Markdown looks like this [Live Link]()

MVP List

• Add a description of the app at the top
• Add a description for User Auth. Check out the Bluebird Wiki for reference
• MVPs 3-7 should be named and listed as the following
  • 3. Events (CRUD)
  • 4. Join a Group/Event (CRUD)
  • 5. Maps
  • 6. Search
  • 7. Production README
• Each MVP should have 2-3 detailed bullets. Distinguish between what logged in and logged out users are able to do with each feature
• Add estimation of days needed for each MVP

Database Schema

• Data types and values look good
• Schema should be a heading at the top not attached to first table. Use markdown hash system for headings
• All table names should be backticked i.e. users, events, etc.
• All column names should be backticked i.e. column_name
• details should be bulleted and references should be backticked.
  • checkout bluebird wiki for reference
• The id column of each table should have the detail of "primary key"

Sample State

• On the right track with the data
• Should have the for top level keys of entities, ui, session, and errors
• State should be one object wrapped with tripple backticks
  • The opening set of tripple backticks should be followed with js to render the object javascript object colorization

Backend Routes

• All routes should be backticed i.e. GET /api/session - Get current user if someone is logged in
• Routes don't need to be headings but fine to keep if you want
• You'll need a route to join or leave a group/event, think RSVP table
• Routes should match schema table naming

Frontend routes

• Routes and descriptions should be backticked i.e. /login
  • See bluebird wiki for reference