Simpl - video player for devs

A video player, specially for devs
Project Homepage »

Table of Contents

1. Introduction
   • Novelty
   • Flow chart of Methodology
   • Functionalities
   • Built With
2. Getting Started
   • Getting Started (Development)
   • Prerequisites
   • Installation
   • Building
3. Usage
4. License
5. Contact
6. Acknowledgement
7. Info

✨ Introduction

In this internet age, everyone is learning to stay ahead in their career or to develop something new, creative and fun. Digging the internet for quality tutorials, watching that youtube videos of blender, illustrator, photoshop, webdev and coding along. Coding along with videos is a nightmare specially if you are only having one single display. Simpl allows you to watch your favourite tutorial, with minimalistic interface and functionalities, so that the video player controls do not occupy the space, only showing video on the screen.

🌠 Novelty of the Idea

There are plenty of video players, in the market, but they come with bulky interfaces, features that we don't use while we are learning or watching any tutorial. Simpl is a simple video player comes with only needed features yet is richful, that do not occupies much space of the interface. Only view your video.

💿 Flow Chart of Methodology

🌟 Functionalities

• Following are the functionalities implemented till now:

• Play anything (subtitles included)

  • Just drag and drop your video to play.
  • Just drag and drop your subtitle file to play it along the video.

• Cross platform application

  • powered by ElectronJS,one code to run on all platforms.

• Minimalistic design

  • only see the usefull stuff on the screen, not the typical useless and bulky UIs.

• Keyboard support

  • control the whole video right from your keyboard.

🛠 Built With

This is achieved with ElectronJS, and the whole application is written in html, css and vanilla javascript, and the application is build with electron-builder, for cross-platform compatibilty.

• electron
• electron-builder

🚲 Getting Started

• Just go to the Homepage, and download the package as per your OS.

• After opening the application, just drag and drop the video on the application, you want to see.

• Only available for windows till now, support for macOS and linux is coming soon.

🚵‍♂️ Getting Started (Development)

This section will help you to get started with the project, locally.

⭐ Prerequistes

• You should be having nodeJS version > 12.x
• After this install electron globally with

  npm i electron -g

If any error occurs in windows, try to install it with CMD opened in admin mode.

📦 Installation

• Clone the project locally with

    git clone git@github.com:daxter-army/simpl.git

• After navigating into project directory, hit

    npm install

• After the installation of the node modules

    npm run start

• You have done it, you will be seeing a window running on your screen, if everything goes well.

🔨 Building

To create one distributable file on windows, you need to download electron-builder

• Install electron-builer globally

  npm i electron-builder -g

• To create a distributable for windows platform, in zip format

  electron-builder -w zip

• To create a distributable for windows platform, in 7zip format

  electron-builder -w 7z

• To create a distributable for 32bit windows platform

  electron-builder --windows nsis:ia32

• To create a distributable for 64bit windows platform

  electron-builder --windows nsis:x64

Feel free to experiment here, with package bundling.

• Now there would be a dist folder, containing the application

🚗 Usage

You can use it to watch your favourite tutorials, with great ease and great functionalities, and focus only on what matters 💯.

📄 License

Distributed under the MIT License. See LICENSE for more information.

🔗 Links

Mehul Singh Teya - mehulsinghteya@gmail.com | LinkedIn
Project Link: https://github.com/daxter-army/simpl
Project Homepage : https://daxter-army.github.io/simpl

🌠 Acknowledgement

• Fontawesome
• Electron
• Electron Builder