Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/bhj/KaraokeEternal

Open karaoke party system
https://github.com/bhj/KaraokeEternal

cdgraphics karaoke karaoke-application karaoke-event karaoke-parties karaoke-player mp3 mp4 node node-js party react reactjs self-hosted sqlite

Last synced: about 2 months ago
JSON representation

Open karaoke party system

Lists

README 

        
# Karaoke Eternal



Host awesome karaoke parties where everyone can easily find and queue songs from their phone's browser. The player is also fully browser-based with support for MP3+G, MP4 videos and WebGL visualizations. The server is self-hosted and runs on nearly everything.



[![Karaoke Eternal](/docs/assets/images/README.jpg?raw=true)](/docs/assets/images/README.jpg?raw=true)





  App in mobile browser (top) controlling player in Firefox/Chrome (bottom)




## Features



- Supports:

  - MP3+G with Winamp/MilkDrop visualizations (WebGL 2)

  - MP4 videos

  - ReplayGain tags for volume normalization

- Fast, modern mobile browser app designed for "karaoke conditions"

- Multiple simultaneous rooms/queues (optionally password-protected)

- Dynamic queues keep parties fair, fun and no-fuss

- Fully self-hosted

- No ads or telemetry



Microphones are *not* required since the player itself only outputs music - this allows your audio setup to be as simple or complex as you like. See the [F.A.Q.](https://www.karaoke-eternal.com/faq/#whats-the-recommended-audiomicrophone-setup) for more information.



## Getting Started



 Karaoke Eternal basically has 3 parts. See [Getting Started](https://www.karaoke-eternal.com/docs/getting-started/) to get up and running step-by-step, or jump to the documentation for each part below:

 

- **[Server:](https://www.karaoke-eternal.com/docs/karaoke-eternal-server/)** Runs on pretty much anything to serve the web app and your media files, including a Windows PC, Mac, or a dedicated server like a Raspberry Pi or Synology NAS.

- **[App:](https://www.karaoke-eternal.com/docs/karaoke-eternal-app/)** Fast, modern mobile web app designed for "karaoke conditions".

- **[Player:](https://www.karaoke-eternal.com/docs/karaoke-eternal-app/#player)** Just another part of the app, but meant to run fullscreen on the system handling audio/video for a [room](https://www.karaoke-eternal.com/docs/karaoke-eternal-app/#rooms-admin-only)



## Installation



There are several [installation methods](https://www.karaoke-eternal.com/docs/karaoke-eternal-server/#installation) available for Karaoke Eternal Server.



## Discord & Support



Join the [Karaoke Eternal Discord Server](https://discord.gg/PgqVtFq) for general support and development chat, or just to say hi!



## Contributing & Development



Contributions are welcome! Please join the `#dev` channel of the [Discord Server](https://discord.gg/PgqVtFq) before embarking on major features; the project's scope is limited to ensure success.



Make sure you have [Node.js](https://nodejs.org/en/) 16 or later, then:



1. Fork and clone the repo

2. `npm i`

3. `npm run dev` and look for "Web server running at" for the **server URL**