Giter VIP home page Giter VIP logo

learn-with-me's Introduction

Landing Page Dashboard Classroom

Table of Contents

##Technology Stack

  • React.js & React Router
  • Node.js & Express
  • PostgreSQL
  • Webpack
  • Socket.io
  • Twilio API

Description

Learn With Me is an interactive application that allows users to watch screencast lessons, chat directly with the lecturer, and whiteboard their personal notes, creating the full classroom experience remotely.

##Example / Usage

Sign up for an account, and you will be up and running in no time!

##Getting Started

Requirements

Installing Dependencies

Ensure PostgresSQL installed. Create a database:

CREATE DATABASE classly;

Use the newly made database and run this query this user table:

CREATE TABLE students(id SERIAL PRIMARY KEY NOT NULL, firstname TEXT NOT NULL, lastname TEXT NOT NULL, email TEXT NOT NULL, stars INT NOT NULL, password TEXT NOT NULL);

On the server.js file be sure to change the following line to fit your username, port, and password of the database:

var db = pgp("postgres://danialsajjad:@127.0.0.1:5432/classly");

From the root directory run:

npm install
npm install -g nodemon webpack
webpack --watch
nodemon server.js

//visit localhost:8000 in the browser.

Create a .env file that includes the following:

TWILIO_ACCOUNT_SID=''
TWILIO_API_KEY=''
TWILIO_API_SECRET=''
TWILIO_CONFIGURATION_SID=''

Fill out the above with the information you received from Twilio.

Testing

Client side testing is implemented with Karma and Airbnb's Enzyme framework. Developers can pinpoint the source of their errors's using Enzyme's shallow rendering and Karma's sourcemap. Server side testing is implement with Supertest and Chai.

From the root directory run:

npm test

Architecture

High Level Architecture

Architecture

Future Road Map

  • Implement email notification on signup
  • Save notes on dashboard and show last 5 notes on classroom page
  • Develop course creation
  • Ability to rate teachers and students
  • Payment processing
  • Separate teacher and student portals
  • Scheduling capabilities for teacher office hours and email notification for appointments
  • Recording of session and accessing sessions on dashboard
  • Teacher and student profile
  • Camera rotation
  • LinkedIn OAuth for teachers
  • Subscribing to teachers
  • Integration with Google calendar

Team Members

Team v2.0

Product Owner: Rodaan Rabang

Scrum Master: Kent Lee

Development Team: Dan Sajjad, Esther Cuan,

Team v1.0

Product Owner: Ashwini Jogwar

Scrum Master: Cathy Lee

Development Team: David Doan, Jen Wong

"Distributed under the MIT License."

learn-with-me's People

Contributors

ashjd avatar caathylee avatar dansajjad avatar david-doan avatar esthercuan avatar jenjwong avatar kqlee avatar rodaan avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.