Skip to content

Latest commit

 

History

History
81 lines (61 loc) · 1.52 KB

readme.md

File metadata and controls

81 lines (61 loc) · 1.52 KB
Raw

Everybody Writes

A real-time classroom feedback tool in your browser

Features

Note: Only compatible in ES6 browsers (Chrome)

  • Anyone with URL can join
    • Joining a room available from homepage
    • First person is considered owner

Roles

  • Owner
    • First person is considered owner
    • Owner can be switched by owner
    • If owner leaves, next earliest user is promoted
    • Owner can assign roles to others
    • Can Hide a user (for inappropriate content)
  • Student
    • Default role when joining room
  • Assistant
    • Can mark answers correct/incorrect
    • Can Hide a user (for inappropriate content)

Board Setup

  • Instructions
  • Options
  • Answer (to auto-accept answers)
  • Timer

Input Types

  • Textarea
  • True/False
  • Code Editor
    • Allow choice of language
  • Multiple Choice
    • Correct answer
  • Whiteboard
  • Markdown
  • Fist of 5

Bugs

  • BUG: Case insensitive URLs

Backlog

  • Highlight a good answer
  • Accepted vs non-accepted answers
    • Highlight a good answer

Technologies

Server

  • NodeJS
  • Express
  • Socket.io

Client

  • ES6
  • Handlebars

Techniques used

DOM Manipulation, HOF, Event Delegation, OOP Interfaces

Running an exercise locally

Clone repo:

git clone https://github.com/chadwithuhc/everybody-writes.git
npm install
nodemon index.js
# OR
npm run dev

Developers

Developer Docs are available if you are interested in contributing