micah-jaffe/caesarnote

A cryptographic cloud-based note-taking app

caesarnote's Issues

Proposal

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

---

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
  • Includes the following list for the 4 app specific MVPs:
    • Adequate styling
    • Smooth, bug-free navigation
    • Adequate and appropriate seeds to demonstrate the 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
  • MVPs are listed in an ordered list
  • Each MVP is broken down into bullet points

Comments

---

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

---

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

PA Review: User Authentication

• Backend: DB, model, controller, views
• Redux Loop: ajax, actions, reducer
• Presentational Components and Containers
• Styling
• Smooth, bug-free navigation
• Adequate and appropriate seeds

PA Review: Notebooks MVP

• Backend: DB, model, controller, views
• Redux Loop: ajax, actions, reducer
• Presentational Components and Containers
  • User can create new notebook via clicking a button and submitting a form in modal
  • User can update and delete notebooks by clicking the actions icon in notebooks index
• Styling
• Smooth, bug-free navigation
  • User can navigate to notebooks index page via link in main sidebar
  • User can navigate to notebook show page by clicking link on notebooks index page
• Adequate and appropriate seeds

PA Review: Tags

• Backend: DB, model, controller, views
• Presentational Components and Containers
  • User can add and remove tags
  • User can delete all instances of a tag from tags page
  • User can delete taggings from a note without deleting all instances of the tag
• Styling
• Smooth, bug-free navigation
• Adequate and appropriate seeds

PA Review: Rich Text editing

• Backend: DB, model, controller, views
• Presentational Components and Containers
  • User can add rich text features to notes
• Rich text features persist to database
• Styling
• Smooth, bug-free navigation
  • User can navigate adequately in rich text editor
• Adequate and appropriate seeds

PA Review: Notes MVP

I finished most of the Notes MVP over the weekend. The rich text editor is still a bit buggy but since that's technically a separate MVP I figured I would put this one up for review. Notebooks and notes go hand in hand so they can probably be reviewed together.

• Backend: DB, model, controller, views
• Redux Loop: ajax, actions, reducer
• Presentational Components and Containers
  • User can create new notes from notebook show page
  • User can create a new note in default notebook from All Notes page
  • User can view all notes in given notebook on notebook show page
  • User can view all notes on All Notes page
  • User can update notes by changing the title or body - notes will autosave
• Styling
• Smooth, bug-free navigation
  • User can navigate between All Notes and Notebooks via sidebar
  • Modals and dropdowns display appropriately and lead to correct places
• Adequate and appropriate seeds