Skip to content

joshmfrankel/ruby-code-sample-teacher-portal

Repository files navigation

Teacher Portal

Production: https://teacher-markdown-portal.onrender.com/

Admin Portal https://teacher-markdown-portal.onrender.com/admin

Requirements

Github Project: https://github.com/users/joshmfrankel/projects/7/views/1

Pitch Document: https://github.com/joshmfrankel/teacher-markdown-portal/blob/main/pitch.md

This is an architectural document used to organize and plan project decisions. This was copied from the associated Github project which contains all related issues and pull requests.

MVP

  • A way for teachers to sign up and create their accounts
  • Document upload and storage
  • Display Markdown documents as web pages
  • Each file should be accessible on the public web via a unique URL
  • Upload and download other types of documents
  • Admin interface for us to manage teacher accounts
  • Access controls

Stretch

  • Student accounts
  • View metrics for documents

V1

  • Folders of files
  • Students being able to view a list of files in a folder
  • Suggest changes to documents
  • Version control
  • Revision history
  • Multiple simultaneous editors

Technology used