https://github.com/acsenrafilho/karoloke

Um simples tocador de músicas de karaokê para fazer a festa!
https://github.com/acsenrafilho/karoloke

karaoke karaoke-application music-player python3 video-player

Last synced: about 2 months ago
JSON representation

Um simples tocador de músicas de karaokê para fazer a festa!

• Host: GitHub
• URL: https://github.com/acsenrafilho/karoloke
• Owner: acsenrafilho
• License: mit
• Created: 2020-09-06T18:02:48.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2025-07-15T01:35:40.000Z (4 months ago)
• Last Synced: 2025-09-06T09:43:11.384Z (about 2 months ago)
• Topics: karaoke, karaoke-application, music-player, python3, video-player
• Language: HTML
• Homepage:
• Size: 71.4 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Karol-Oke

![Project Logo](docs/assets/karoloke-logo.png)

[![CI for Develop Branch](https://github.com/acsenrafilho/karoloke/actions/workflows/ci_develop.yaml/badge.svg)](https://github.com/acsenrafilho/karoloke/actions/workflows/ci_develop.yaml)

[![CI for Production Branch](https://github.com/acsenrafilho/karoloke/actions/workflows/ci_main.yaml/badge.svg)](https://github.com/acsenrafilho/karoloke/actions/workflows/ci_main.yaml)

[![codecov](https://codecov.io/gh/acsenrafilho/karoloke/graph/badge.svg?token=1PL6N4BI2G)](https://codecov.io/gh/acsenrafilho/karoloke)

![Python Versions](https://img.shields.io/badge/python-3.9%20|+-blue)

![PyPI downloads](https://img.shields.io/pypi/dm/karoloke)

[![Issues](https://img.shields.io/github/issues/acsenrafilho/karoloke)](https://github.com/acsenrafilho/karoloke/issues)

![Contributors](https://img.shields.io/github/contributors/acsenrafilho/karoloke)

[![GitHub Sponsor](https://img.shields.io/badge/Sponsor-❤️%20acsenrafilho-orange?logo=github)](https://github.com/sponsors/acsenrafilho)

A simple Karaoke framework to make your party fun and easy!

## Installation

- Requires **Python 3.9+**

- Install via pip:

  ```bash

  pip install karoloke

  ```

## Usage

- Start the application:

  ```bash

  karoloke

  ```

- The server will start locally.

- Setup your videos database path by simply informing the diretory full path into the settings button (up-right corner) (supports: `.mp4`, `.webm`, `.ogg`).

- The karaoke interface runs in your web browser (Chrome, Firefox, or similar) using an embedded web player for seamless playback.

- Simply open the provided local URL after starting the server to access the karaoke experience.

## Documentation

Full documentation is available at [ReadTheDocs](https://karoloke.readthedocs.io).

## Contributors

Thank you all the special people that invested their time and knowledge to improve this project. 👏

![Contributors](https://contrib.rocks/image?repo=acsenrafilho/karoloke)