README.md

ClassTranscribe 2018

ClassTranscribe is an open-source, web-based platform that leverages crowdsourcing to address the problem of accurate, reliable and fast transcriptions of college lectures. Completed transcriptions provide search functionality that augments existing lecture recordings and enable enhanced educational features including closed captioning. Some early ClassTranscribe conference papers include - Slate 2015 and ASEE 2019.

Important Notice - The project here has been superceded by github.com/classtranscribe

The all-new-version of ClassTranscribe is at [https://github.com/classtranscribe]

How to run your own instance of ClassTranscribe

Refer to Docker/readme.txt

Structure

db.js

A MSSQL based API tool offering database-interaction functions.

models

models used to build sql tables

index.js

Initialize the tables

primary_key
foreign_key

courseOffering.js

courseId	offeringId

courses.js

id	courseNumber	courseName	courseDescription	deptId

dept.js

id	deptName	acronym

echo_section.js

sectionId	courseId	json

lecture.js

id	date	offeringId	mediaId

media.js

id	videoURL	sourceType	siteSpecificJSON

ms-transcription-task.js

id	videoLocalLocation	audioLocalLocation	siteSpecificJSON	videoHashsum	audioHashsum	wavAudioLocalFile	wavHashsum	srtFileLocation	log	taskCreatorUserId	mediaId

offering.js

id	section	termId	deptId	universityId

role.js

id	roleName

term.js

id	termName

university.js

id	universityName

user.js

id	mailId	firstName	lastName	password	verifiedId	universityId

userOffering.js

userId	offeringId	roleId

router

Here contains server side features and functions

index.js is the general setup routes has various js files that we are currently using

• accountRecovery.js renders accountRecovery mustache
• activated.js renders activated mustache
• admin.js renders admin mustache
• base.js renders home mustache
• captions.js not sure
• changePassword.js renders changePassword with changePassword functions
• courses.js renders courses mustache, it is relative to addCourse page. Important file
• dashboard.js renders dashboard
• download.js is relative to files in /public/Downloads
• first.js renders index mustache, it is relative to lecture videos
• login.js renders login mustache, it is relative to login page
• logout.js logout the account, and change the URL to home directory
• manage.js renders manageCourse mustache, it has relative functions about adding instructors, lectures, students
• progress.js renders progress mustache, it is relative of sending progress emails
• queue.js renders queue mustache, it uploads files?
• resetPassword.js renders resetPassword mustache, it has relative functions about resetPassword
• search.js renders search mustache, it has relative functions about getting videos, course, or captions
• second.js renders editor mustache, it has a function that saves the transcription
• settings.js renders settings mustache, it has relative functions about settings
• signup.js renders signup mustache and verify, it has relative functions of signing up.
• viewer.js renders viewer mustache
• viewProgress.js renders progressDashboard mustache
• watchLectureVideos.js renders watchLectureVideos mustache, it has a relative function of getting videos