Skip to content
This repository has been archived by the owner on Jun 4, 2019. It is now read-only.

ripples/lv-client

Repository files navigation

lv-client

This repository is a submodule of the Lecture-Viewer system developed by the ripples team at UMass Amherst.

The purpose of lv-client is to act as the frontend web interface for the Lecture-Viewer microservice stack. It allows instructors and students to have ease of access to their learning media created using other components of the system.

How to run

We only support running lv-media through docker and docker-compose. Follow the instructions in the parent repository readme

Documentation

ESDoc is being used for documentation and documentation generation. To use it, run npm run doc in this folder and open source.html of the created esdoc folder. Please refer to the ESDoc documentation for how to implement.

Code style

We adhere to the ESLint Google style guide. Please follow this style guide to maintain a high quality repository.

Core Technologies used