Skip to content

Concept.md

Latest commit

 

History

History
71 lines (48 loc) · 2.49 KB

Concept.md

File metadata and controls

71 lines (48 loc) · 2.49 KB
Raw

Concept

  • Readme
  • Blog Post
  • Video Demo
  • Project summary
  • Problem statement
  • User stories / features
  • Model your domain

Project Summary

Flip Code is a flashcard app. Users jot down snippets of code on one side and then the corresponding psuedo-code on the other side as a way of fostering understanding through memorization.

Problem Statement

There's no easy way to memorize code that has line-by-line description. This product aims to mimic the purpose of git comments. For example a user sees git commit -m 'a super-detailed description' next to each commit in github and knows exactly what that commit does next to the line of recently added code.
Flip Code is a good place to keep notes for tricky edge-cases that are hard to remember.

Main Goal

  • Error Messaging
  • Create new card - C & R of CRUD. ()
  • SPA - Single Page Application
  • Card Page shows one card at a time
  • Card has Two sides
  • Card Has Prev/ Next and Flip
  • Side 1 - Questions (or actual code)
  • Side 2 has Title that gives general description of Code.
  • Side 2 - Answers (or psuedo code)
  • No Users for now

Nice To Haves

User Stories

  • TBD

Domain Modeling

  • Need Help / TBD

Project Requirements

  • The application must be an HTML, CSS, and JavaScript frontend with a Rails API backend. All interactions between the client and the server must be handled asynchronously (AJAX) and use JSON as the communication format.

  • The JavaScript application must use Object Oriented JavaScript (classes) to encapsulate related data and behavior.

  • The domain model served by the Rails backend must include a resource with at least one has-many relationship. For example, if you were building an Instagram clone, you might display a list of photos with associated comments.

  • The backend and frontend must collaborate to demonstrate Client-Server Communication. Your application should have at least 3 AJAX calls, covering at least 2 of Create, Read, Update, and Delete (CRUD). Your client-side JavaScript code must use fetch with the appropriate HTTP verb, and your Rails API should use RESTful conventions.