Skip to content
This repository has been archived by the owner on Apr 30, 2020. It is now read-only.

Latest commit

 

History

History
147 lines (84 loc) · 6.41 KB

README.md

File metadata and controls

147 lines (84 loc) · 6.41 KB
Raw

FullTeaching

NOTE: This project is not maintained. We are working in a big refactoring as part of an student project here: https://github.com/codeurjc-students/2019-FullTeaching/tree/Angular-Refactor

Build Status

What is FullTeaching?

FullTeaching is an educational web application to make online classes easy for teachers as well as students. Its current main features are the following:

  • Teachers can create all the courses they want and easily invite their students. Every user will see their courses and sessions well ordered on their dashboards.

  • Teachers can establish an unlimited number of classes for each course, indicating the content and date for each one of them.

  • A calendar view is provided in order to check all your classes at a glance.

  • Every course has a forum where the users can open entries, write comments and reply others so they can share doubts and knowledge.

  • Teachers have an advanced system for attaching files to a course. They can customize groups of files, name them as they want and reorder them at any moment. The uploading process has been greatly simplified.

  • FullTeaching uses OpenVidu technology to provide video-conference capabilities. Teachers can initialize a class and every student invited can connect and see the teacher in real time. FullTeaching also allows students to intervene during the class (the teacher must authorize it first).

Dashboard: all your courses and your calendar

Calendar: here you have all your sessions, with direct access to their specific course

Classes: ordered by date, teachers can easily add new ones and modify existing ones

Forum: unlimited entries for posting all your questions

Files: advanced tree structure to keep all the course's files clear and tidy

Adding students to the course is as simple as pasting their emails. FullTeaching will automatically do the rest

Quick start guide

How to execute a demo FullTeaching service (Docker)

To get FullTeaching working in the easiest way, you just have to download the file above docker-compose.yml and run docker-compose up in its directory. This will pull all the necessary images from DockerHub and will execute everything (it will take one minute after the pull ends). Go to http://localhost:5001/ and there you have it!

You will need some user data to test the features. These are the default users for the demo:

When entering a video lesson, you might have a certificate error when connecting to OpenVidu Server. You must navigate to the URL of OpenVidu Server and accept it (port 4443, host the docker IP for the container openvidu/openvidu-server-kms:2.3.0, probably something like 172.17.0.X)

How to develop FullTeaching

To get a full development version of the app just execute the following commands:

Prerequisites

  • Java 8

    Check version:

    java -version

    Install:

    sudo apt-get install -y default-jdk

  • AngularCLI ( which requires Node.js > 4.x.x and npm > 3.x.x )

    Check versions:

    node -v
npm -v
ng -v

    Install:

    sudo apt-get install nodejs
sudo apt-get install npm
npm install -g @angular/cli

  • Maven

    Check version:

    mvn -v

    Install:

    sudo apt-get install maven

  • MySQL

    Check version:

    mysql --version

    Install:

    sudo apt-get update
sudo apt-get install mysql-server
sudo mysql_secure_installation

Installation and execution

First of all, it is necessary to create a schema for MySQL:

mysql -u root -p
CREATE DATABASE full_teaching;
exit

Then we can build and run the project:

git clone https://github.com/OpenVidu/full-teaching.git
cd full-teaching/src/main/angular
npm install
cd ../../../
./BuildFrontWarAndRun.sh

This clones the project in your working directory, installs dependencies with npm install and executes the BuildFrontJarAndRun.sh script.

This script BuildFrontJarAndRun.sh builds the FrontEnd with angular-cli, copies all generated files to the Backend static folder, builds and generates the WAR with Maven and runs the WAR file.

Go to http://localhost:5000/ and there you have it!

❗ IMPORTANT:

  • Before executing the script to build and run the app, it is necessary to change the following properties of application.properties file to match your credentials for MySQL:

    spring.datasource.username=YOUR_USERNAME
spring.datasource.password=YOUR_PASS

  • You may have to change permissions in order to execute the scripts.

These instructions have been tested for Ubuntu 14.04 and Ubuntu 16.04

Acknowledgments

FullTeaching has been supported under project LERNIM (RTC-2016-4674-7) confunded by the Ministry of Economy, Finance and Competitiveness of Spain, as well as by the European Union FEDER, whose main goal with this funds is to promote technological development, innovation and high-quality research.