TeleQuest

Web App That Promotes Interactivity During A Live Video Streaming Session (Senior Project - Spring 2019)

Table of Contents

• TeleQuest
  • Table of Contents
  • Installation
    • Clone
    • Setup
  • Docker
    • Troubleshooting
  • Features
  • Usage
  • Documentation
    • Wiki
    • Config Folder
  • Tests
  • Contributing
  • Team
  • License

Installation

Please refer to our project Wiki for Node.js installation

Clone

Clone this repo to your local machine using https://github.com/RajendraBhagroo/TeleQuest.git

$ git clone https://github.com/RajendraBhagroo/TeleQuest.git

Setup

Install dependencies from all npm packages

$ cd TeleQuest/ 
$ npm run install-script-dev

• To complete setup, please refer to the Config Folder section

Docker

Build and run containers

$ cd TeleQuest/
$ docker-compose -f docker-compose-dev.yml build
$ docker-compose -f docker-compose-dev.yml up -d

Teardown containers

$ docker-compose -f docker-compose-dev.yml down

Troubleshooting

• If you are using Docker Toolbox, please use the IP address of your docker-machine when accessing ports locally

$ docker-machine ip

• Run only server

$ docker-compose -f docker-compose-dev.yml run server

Features

Usage

• Follow installation instructions prior to usage and ensure you are at project root directory

Run application (Server And Client)

$ npm run app-dev

Run only server

$ npm run server

Run only client

$ npm run client

Documentation

Wiki

Please refer to our project Wiki for extended documentation

Config Folder

• Config folder is located at the root of the project.
• Both, client & server share the same config. [CRA obscures .env at build-time]

Folder structure

config/
    .env
    .env.example

.env [Example]

# Client
PORT=3000

# Server
HOST=127.0.0.1
NODE_PORT=3001
SERVER_VERSION=v1
MONGO_DB_URI=<Insert Your Mongo URI>
JWT_SECRET=<Insert Your Secret>
JWT_EXPIRE=604800

Tests

Contributing

To get started...

• Review our Code Of Conduct
• Please refer to our project Wiki for setting up Verified Commits (required)
• 🔃 Create a new pull request using our Template

Team

Core development team

RajendraBhagroo	Chris	Kim
github.com/RajendraBhagroo	github.com/gint0kix	github.com/Gold-Turtle

License

• Massachusetts Institute of Technology