Code Monkey home page Code Monkey logo

iframe-site's Introduction

iframe-site

"It's like tmux but for videos"

The iframe-site is a project to allow people to configure the contents of a screen without having to remote into it.

Modules

There are three modules:

  • viewer: Containing the logic for the viewing page
  • server: Containing the logic for the websocket server
  • configurator: Containing the logic for the configuration page

Installation

To install the project for development, you need to

  • run npm install in each of the modules
  • Go to the google api console (https://console.developers.google.com/apis)
    • Create a free project named something like iframe-site
    • Click on the menu on the left, go to credentials and create an API key and an OAuth 2.0 client ID. When you create the Oauth Client ID, add http://localhost:3001 and http://localhost:3000 as Authorized JavaScript origins.
    • create a secrets.js file in 'configurator/src/googleAuth' with
export const API_KEY = "YOUR API KEY HERE"
export const CLIENT_ID = "YOUR CLIENT ID HERE"
  • Click on the menu on the left, go to Library, and enable the Google+ API. (You may also need the People API, but I don't think so)

To run the project for development, all you have to do is to go into each of the three modules and run npm start

To deploy the project to a dedicated server, you should run npm run build in each of the react apps (viewer and configurator), and then deploy the built static files onto any standard static webserver. You also need to set up the websocket server to run, which we don't provide a standard way to do, but I'm checking in a systemd service file which you may find helpful. You also need to make sure that port 10050 is forwarded to your server from the internet.

iframe-site's People

Contributors

kj800x avatar

Stargazers

Michael Wong avatar

Watchers

James Cloos avatar  avatar  avatar

Forkers

muskanmahajan37

iframe-site's Issues

Enhance UI for config page

The UI is pretty minimalist. We don't have a designer so whoever picks this up (me or anyone else) can just go ahead and makes something. If it turns out to not be too good, we can redo it.

It might be a good idea to have the config page mirror the viewing page, just with urls and config options instead of actually displaying the iframes.

Scale IFrames Option

This way if a page is too small with just a quarter of the screen, we can scale it down by 50%

Profile pictures take up too much space

Problem Statement

The user images take up too much space. Considering the relatively small screen size of each section, the auth images should be as unobstructive as possible.

Proposed Solution

Change overlay to show only the user image, not showing the name until you hover over the image.

Conversations Integration

Problem Statement

The paywall page needs a chat widget to be integrated so that visitors can be connected to a sales representative in an inbound way.

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.