classtranscribe Goto Github PK

Project Overview

Class Transcribe is a platform that students use to view lecture videos from their instructors. You can view the main repository for Class Transcribe here. However, Class Transcribe only comes in the form of a web app, which has many downsides, including inconveniencing students. This project focuses on creating a mobile application for Class Transcribe. This application aims to allow students to find, watch, and download lecture videos for their classes.

Getting Started

Prerequisites

You must have node.js and yarn installed.
For node, make sure you install version 12.21.0. Newer versions may not yet be supported by expo. You can install node here
After installing node, npm should be automatically installed. Use npm to install yarn with npm install --global yarn. See more details here

You will also need the Android Device Bridge and potentially an emulator if you don't own a physical device. It is recommended to install all of this through Android Studio for sake of simplicity. Download and install Android studio from here

Dependencies

After cloning the repo, run yarn install in the root of the project to install all dependencies. View package.json to see a list of all dependencies that will be installed.

Running

Currently only Android is supported. First you must have a device to run this application on. Either start up an emulator or plug in your phone. After doing so, run yarn android and the application should automatically be installed with expo.

Documentation

See extensive documentation here https://docs.google.com/document/d/1xfkTi_AHDhBvYQkOnpxpWJLESQcI2hHC9ywgakymNYw/edit?usp=sharing.

Contributors

Andrew Zhang, Matthew Walowski, Akshaya Jagannadharao, Gary Liu, Suxiang Han