https://github.com/dvinciguerra/video-downloader

PoC app using Ruby, Sinatra, and Sucker Punch to create a video downloader UI
https://github.com/dvinciguerra/video-downloader

proof-of-concept ruby sinatra sucker-punch webapp

Last synced: 25 days ago
JSON representation

PoC app using Ruby, Sinatra, and Sucker Punch to create a video downloader UI

• Host: GitHub
• URL: https://github.com/dvinciguerra/video-downloader
• Owner: dvinciguerra
• Created: 2024-06-10T21:15:28.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-06-10T23:37:12.000Z (5 months ago)
• Last Synced: 2024-06-12T04:54:08.934Z (5 months ago)
• Topics: proof-of-concept, ruby, sinatra, sucker-punch, webapp
• Language: Ruby
• Homepage:
• Size: 117 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Video Downloader UI

[![Maintainability](https://api.codeclimate.com/v1/badges/ac38ba2861038f191dd2/maintainability)](https://codeclimate.com/github/dvinciguerra/video-downloader/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/ac38ba2861038f191dd2/test_coverage)](https://codeclimate.com/github/dvinciguerra/video-downloader/test_coverage)

Project for building a user interface for video download.

![](./public/screenshot.png)

This project aims to practice the use of the Sinatra framework and the use of background job libraries for asynchronous task execution.

## Installation

To install the application, simply download the project having a Ruby version above 3.0 and Bundler.

`bundler install && gem install foreman`

Once done, start the application with the command:

`foreman start`

## Functionality and Project Decisions

The project uses the `yt-dlp` tool to download videos, simulating a time-consuming process and thus uses Sucker Punch for background job execution.

The web interface is created using Bootstrap since the focus is not on working on the interface or CSS skills, and Sinatra as the web framework.

Job execution is done asynchronously, allowing the user to continue using the application while the download is in progress.

This behavior was created using Sucker Punch, a gem that implements job execution using threads, eliminating the need for extra infrastructures like Redis or databases used by other gems.

Videos are downloaded into one directory and their thumbnails into another directory to enable creating enhanced display screens in the future.

So far, no database has been considered to maintain the information, but in the future, if I still want to further study this project, I plan to use SQLite to create categories, maintain video metadata, and maybe create playlists per user.

## Author

Daniel Vinciguerra