Giter Club home page Giter Club logo

overlay's Introduction

Overlay

Overlay is an app that can be used to watch videos from plattforms like Youtube and Twitch. It lays and stays on top of other windows. The app can be used on Windows, MacOS and Linux.

Main window

Video window

Use this tool to watch youtube videos for example or learn to code, while keeping the video on top of others without wasting space with black bars.

Features

  • Minimalistic UI
  • Support for Youtube, Twitch and Dailymotion
  • Portable on Linux and MacOS with .AppImage and .app format respectively

1 Get started

At first we need to setup the environment to develop the app.

1.1 Prerequisites

The package manager used here, is yarn. First install yarn for example with brew by typing:

brew install yarn

1.2 Installing

After installing yarn the setup is pretty straight forward. The project contains a package.json which lists all required packages. The file yarn.lock contains all the packages the developer used recently.

Install dependencies by entering:

yarn install

2 Development

2.1 Run application

Use the following statement to run the application:

yarn start

2.2 Linting

This project is equipped with ESLint for code quality standards. To lint the whole project you can use the yarn script:

yarn lint

3 Deployment

To build an executable for your current plattform use the following command.

yarn build

4 Testing

To run all the tests use the following yarn script:

yarn test

Built with

Authors

  • David Littig - Initial work - GitHub

Enjoy!

overlay's People

Contributors

dlittig avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

overlay's Issues

Add updates

Add functionality to get notified about updates and download new releases

  • Option to dismiss notifications in the future for 7 days
  • Option to download recent version
  • Use nuts server: https://github.com/GitbookIO/nuts on OpenShift or Heroku

Add timestamp support

When adding videos with &t=123 the timestamp is being ignored.
Add support so the opened video skips to the given timestamp.

Fix tests

Check if enzyme or react-testing-library can be used. Modify tests accordingly.

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.