Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/headsetapp/headset-electron
Official Headset repo
https://github.com/headsetapp/headset-electron
Last synced: 2 months ago
JSON representation
Official Headset repo
- Host: GitHub
- URL: https://github.com/headsetapp/headset-electron
- Owner: headsetapp
- License: mit
- Created: 2017-03-31T04:29:51.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T11:01:45.000Z (7 months ago)
- Last Synced: 2024-08-03T16:08:59.852Z (6 months ago)
- Language: JavaScript
- Homepage: https://headsetapp.co
- Size: 169 MB
- Stars: 782
- Watchers: 24
- Forks: 71
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-electron - Headset - Discover, collect, and listen to music from YouTube. (Apps / Open Source)
- awesome-electron-zh - Headset - Discover, collect, and listen to music from YouTube. (Apps / Open Source)
- awesomeelectron - Headset - Discover, collect, and listen to music from YouTube. (Apps / Open Source)
README
# Headset
This project is currently not being actively maintained and is not accepting new pull requests or issues. Thank you for your understanding.
> **ATTENTION**: Headset no longer uses a shared YouTube API Key. Please create your own key by [Following this quick guide](https://github.com/headsetapp/headset-electron/wiki/Get-Youtube-API-Key) and make sure you are running the latest version.
[Headset](https://headsetapp.co) is a simple music player for Mac, Windows and Linux with integrated YouTube search, a home screen with popularity list by genres and eras, and best of all, a radio powered by Reddit. Headset takes the songs that are shared in over 80 music subreddits, categorizes them and plays them automatically. It's a great and pretty unique way to find new music as it is chosen by other humans like you and not by algorithms.
Have a question? Join our Slack workspace: https://tinyurl.com/8ejkcdac
Want to start contributing? Check out our [contributing](./CONTRIBUTING.md) doc.
## Installation
### macOS (Homebrew)
Update Homebrew and install `headset` using Homebrew Cask
```shell
brew update
brew install --cask headset
```
### Windows (Chocolatey)
To install, run the following command from the command line or from PowerShell:
```shell
C:\> choco install headset
```
To upgrade, run the following command from the command line or from PowerShell:
```shell
C:\> choco upgrade headset
```
More details in the chocolatey page: https://chocolatey.org/packages/headset
### Linux
As an alternative to `.deb` and `.rpm` packages on the website, you can also install it directly from the command-line:
#### Debian
```shell
wget -q https://headsetapp.co/headset-electron/headset.gpg -O- | sudo tee /usr/share/keyrings/headset-archive-keyring.gpg
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/headset-archive-keyring.gpg] https://headsetapp.co/headset-electron/debian stable non-free" | sudo tee /etc/apt/sources.list.d/headset.list
sudo apt-get update
sudo apt-get install headset
```
#### RedHat
```shell
sudo dnf config-manager --add-repo https://headsetapp.co/headset-electron/redhat/headset.repo
sudo dnf install headset
```
--- Or ---
```shell
sudo yum-config-manager --add-repo https://headsetapp.co/headset-electron/redhat/headset.repo
sudo yum install headset
```
#### Build from source
If you would like to create a build for a different environment (e.g Manjaro or Aur, etc.) please follow these steps:
1. Install _NodeJs_ 8 or later
2. Clone the Repo
```shell
$ git clone https://github.com/headsetapp/headset-electron.git
```
3. Install dependencies
```shell
$ cd headset-electron
$ npm ci
```
4. Create your build:
```shell
electron-packager . \
--executable-name headset \
--ignore "(^/bin$|^/sig$|^/gh-pages$|^/player$|^/test$|Procfile|\.md$|^\.|^\/\.)" \
--prune true \
--out build/ \
--overwrite \
--asar \
--platform=linux \
--arch=x64
```
5. [Optional] For the Ubuntu build, we're using `electron-installer-debian` and for the Fedora build, we're using `electron-installer-redhat`. There might be an installer for your specific version, just have to google it.
## Contributors
[//]: contributor-faces
[//]: contributor-faces
App Design by Hélène Giraud www.girographe.com