Application Specifications - 2011-libra/cap GitHub Wiki

Tier 1 (MVP):

  • Database Schema (session, content)

Editor Functionality

  • Toolbar to format (bold, italics, hyperlink, bullet, etc...)

Guest

  • Guest can create note/document
  • Guest can save/export to local machine in raw markdown format
  • Guest can add code snippets
  • Guest can view the note/document rendered
  • Guest can paste raw markdown / regular text, and will render normally
  • Code Snippet Sandbox to run simple code

Tier 2 (Stretch Goals):

  • Each Guest will have a unique session key, that they can share with collaborators
  • Collaborators can simultaneously edit
  • Application can handle multiple sessions without collision
  • Guest can upload the markdown and continue where they left off

Tier 3:

  • Code Snippet Sandbox to run complex code
  • Code Snippet Sandbox to run different languages
  • Chat/Draw feature

Tech Stack

Database

  • PSQL vs NOSQL

Client & Server

  • React
  • Redux
  • React-Quill (editor / toolbar module)
  • Socket.io
  • Express

Parse

  • showdownjs vs markdown-it

Sandbox

  • Docker
  • Terminal Emulator

Deployment

  • Heroku vs. Firebase (db dependent)

Group Standards

Git / GitHub

  • git commit -m 'T1-FE (Spec Title): ....'
⚠️ **GitHub.com Fallback** ⚠️