Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 1.4 KB

README.md

File metadata and controls

57 lines (40 loc) · 1.4 KB
Raw

InstructorAssistant

Overview

InstructorAssistant is a tool to empower instructors, both primary and secondary, to scale up one-on-one checks for understanding.

Todos

  • Can edit questions after pushing
  • Tracking previous sessions
  • Ability to grade each answer
  • Build sub-components
  • Create favicon
  • Switch from nodemon to node-foreman
  • Long-term data on students
  • Pushing multiple choice questions
  • Real authentication
  • Slackbot to push out the links
  • Field to allow filtering questions

Getting Started

  • Clone the repo to your local machine
  • npm install
  • In one window, start the client with npm run start:dev:client
  • In another window, start the server with npm run start:dev:server
  • Navigate to the port that is logged when starting the server

Docs for Confusing Topics

The process done when creating a new day is:

  1. Create the day in Firebase
  2. Forward to setInstructorPermissions state
  3. If the special link is valid, enable instructor view for that dayId
  4. Forward to the normal URL

There is a special state called setInstructorPermissions. This is because instructors will need to share the special instructor link for other instructors to see the answers.

Special Notes

Webpack dependencies found in package.json

  • JavaScript
    • babel-core
    • babel-loader
  • SCSS
    • style-loader
    • css-loader
    • scss-loader
    • node-sass
  • HTML
    • raw-loader