stellashen/cross-off

:white_check_mark: :memo: A task management web app. Using Ruby on Rails, PostgreSQL, JavaScript/React/Redux, JSX, SCSS. Cross off your tasks and feel good!

cross-off's Issues

PA: REVIEW Lists

• Users can add a new list
• Users' custom lists will be added to the sidebar
• Users can rename or remove a list
• Click a list to view all the tasks under that list
• Adequate styling
• Smooth, bug-free navigation
• Seeded with info to demonstrate this feature

Note:
This works. But I am going to refactor code to change my state shape.
Right now the state has all the tasks. After refactoring, the state should only have tasks of the current list.

Wire Frames & Component Hierarchy

• 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 Lists
• Contains ListItems
• Correctly formatted
  • Wireframe images display on the page
  • Every wireframe has a header title

PA:REVIEW User Auth

• New account creation, login, logout
• guest/demo login
  Adequate styling
  Smooth, bug-free navigation
  Seeded with info to demonstrate this feature

PA: REVIEW User Auth

• New account creation, login, logout
• guest/demo login
• Adequate styling
• Smooth, bug-free navigation
• Seeded with info to demonstrate this feature

CrossOff Heroku Site

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)

PA: REVIEW Tasks

• Users can add a new task
• Each task has a checkbox before its title
• Users can set due dates and save the task to a list
• Users can edit a task
• Users can delete a task
• Users can cross off a task when completed
• Completed tasks will be moved to the "completed" list automatically upon completion
• Adequate styling
• Smooth, bug-free navigation
• Seeded with info to demonstrate this feature

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

MVP List

• Should have 7 MVPs.
  • 3 of those are User Auth, Heroku, and Production README.
  • The other 4 are project specific
• 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

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

Sample State Shape

• State shape is not nested!
• State's keys are camelCased
• Correctly formatted
  • Sample state is rendered with 3 back ticks before and after. 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

PA:REVIEW host on heroku + README

Host on Heroku

• on heroku, production ready

Production README.md

Content:

• Has a # Title
• Links to the Wiki design documents
• Describes technologies used
• Describes core functionality
• Lists future directions
• Fills out Description and Website at the top of the repo.

Format:

• Uses markdown formatting
• Includes code snippets (with triple backticks, and the language ```javascript...```)
• Includes screenshots / gifs