{"id":31179424,"url":"https://github.com/nedpals/pwa-karaoke","last_synced_at":"2025-09-19T15:19:14.937Z","repository":{"id":312605383,"uuid":"1047739460","full_name":"nedpals/pwa-karaoke","owner":"nedpals","description":"A web-based karaoke application that transforms any device into a karaoke system.","archived":false,"fork":false,"pushed_at":"2025-09-12T02:21:32.000Z","size":3719,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-12T02:53:57.448Z","etag":null,"topics":["karaoke","pwa-app","web"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nedpals.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-31T05:39:49.000Z","updated_at":"2025-09-12T02:21:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"9a3ef156-0492-4fe2-b408-1d2a78485fc9","html_url":"https://github.com/nedpals/pwa-karaoke","commit_stats":null,"previous_names":["nedpals/pwa-karaoke"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/nedpals/pwa-karaoke","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nedpals%2Fpwa-karaoke","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nedpals%2Fpwa-karaoke/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nedpals%2Fpwa-karaoke/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nedpals%2Fpwa-karaoke/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nedpals","download_url":"https://codeload.github.com/nedpals/pwa-karaoke/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nedpals%2Fpwa-karaoke/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275958252,"owners_count":25559736,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-19T02:00:09.700Z","response_time":108,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["karaoke","pwa-app","web"],"created_at":"2025-09-19T15:19:09.324Z","updated_at":"2025-09-19T15:19:14.924Z","avatar_url":"https://github.com/nedpals.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PWA Karaoke\n\nA web-based karaoke application that transforms any device into a karaoke system.\n\n\u003e [!IMPORTANT]\n\u003e This software is intended for personal, non-commercial use only. Users are responsible for ensuring compliance with applicable copyright laws and terms of service in their jurisdiction.**\n\n![PWA Karaoke Screenshot](./screenshot.png)\n\n*My Way, Philippines' most deadly karaoke song, playing in PWA Karaoke.*\n\n## Features\n- Use your phone or tablet as a controller and any web-capable device as a display\n- Easy to use and slick user interface\n- Search and queue songs video streaming platforms\n- Supports multiple rooms with password protection\n- Operate entirely within the browser\n\n## Downloads\n### Releases\nComing soon. In the meantime, you may use the \"Clone with Git\" or \"Download ZIP\" methods below.\n\n### Clone with Git\nTo download the application via `git`, simply clone it using `git clone https://github.com/username/pwa-karaoke.git`.\n\n### Download ZIP\nYou can download the source code as a ZIP file by clicking \"Code\" → \"Download ZIP\" on the GitHub repository page.\n\n## System Requirements\n- Minimum 2GB RAM, 1 vCPU\n- Docker (if using Docker or Docker Compose)\n\nSee the [manual setup prerequisites](#prerequisites) when running without Docker.\n\n## Setup\n### Docker Compose\nThe recommended way to run PWA Karaoke is through Docker Compose. This method simplifies the setup process and ensures that all dependencies are correctly configured.\n\n```bash\ndocker-compose up -d\n```\n\nThis will start the backend and [Caddy](https://caddyserver.com/) web server.\n\nVisit `http://localhost` or `http://$DOMAIN` (where `$DOMAIN` is your configured domain) to access the application.\n\n### Docker\n\nIf you have a custom setup that doesn't use Docker Compose, you can run the backend and frontend services separately using Docker.\n\n```bash\n# Build the application\ndocker build -t pwa-karaoke .\n\n# Run the container\ndocker run -d -p 8000:8000 --name pwa-karaoke pwa-karaoke\n```\n\nVisit `http://localhost:8000` to access the application.\n\n### Manual\nA manual setup is also possible. This method requires more steps but allows for greater customization.\n\n#### Prerequisites\nEnsure you have the following installed:\n- Python 3.11+\n- Node.js 20+\n- Docker (optional, for containerized deployment)\n\n#### Steps\nTo set up PWA Karaoke manually, follow the setup procedure below:\n\n```bash\n# Build frontend and bundle into backend\ncd frontend\nnpm install\nnpm run build:prod\n\n# Start the server\ncd ../backend\npip install -r requirements.txt\npython main.py\n```\n\nVisit `http://localhost:8000` to access the application.\n\n## Usage\n\n### Rooms\nAfter starting the server, you will be prompted to **create** or **join** a room. Rooms allows multiple groups to create karaoke sessions independently.\n\n#### Joining a Room\nYou can either browse our list of publically available rooms or enter a room ID to join a private room.\n\n#### Creating a Room\n\u003e [!TIP]\n\u003e You can also add passwords to public rooms to restrict access while still being listed.\n\nWhen asked, you will be prompted with the following details:\n- **Room ID**: You will be provided with a randomly generated room ID or you can set your own.\n- **Room Visibility**: You can choose to make your room be shown **in public listings** or be **private**.\n- **Room Password**: Optionally, you can set a password for your room to restrict access.\n\n### Modes\n\nOnce you create or join a room, you are prompted to enter the room in two modes:\n- **Display Mode:** For TVs, projectors, or multiple screens to show the video playback and song queue. It supports playing to multiple displays in near real-time.\n- **Controller Mode:** For phones or tablets to search for songs and control playback.\n\n### Development\n\nTo contribute to PWA Karaoke, fork the repository and create a new branch for your changes. See the individual README files in the `backend/` and `frontend/` directories for setup instructions. After making your changes, submit a pull request with a clear description of what you've modified.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n**Disclaimer:** This software is provided \"as is\" without warranty of any kind. Use at your own risk and ensure compliance with all applicable laws and terms of service.\n\n© 2025 Ned Palacios\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnedpals%2Fpwa-karaoke","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnedpals%2Fpwa-karaoke","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnedpals%2Fpwa-karaoke/lists"}