Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spotlightify/spotlightify
The Spotify overlay controller
https://github.com/spotlightify/spotlightify
cross-platform golang gui music react spotify spotlight spotlightify typescript wails
Last synced: 19 days ago
JSON representation
The Spotify overlay controller
- Host: GitHub
- URL: https://github.com/spotlightify/spotlightify
- Owner: spotlightify
- Created: 2020-05-23T01:20:06.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T20:35:05.000Z (about 2 months ago)
- Last Synced: 2024-09-18T16:40:56.662Z (about 2 months ago)
- Topics: cross-platform, golang, gui, music, react, spotify, spotlight, spotlightify, typescript, wails
- Language: TypeScript
- Homepage: https://spotlightify.github.io
- Size: 29.6 MB
- Stars: 220
- Watchers: 8
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GLP-3.0 License][license-shield]][license-url]
[![Discord][discord-shield]][discord-url]
Table of Contents
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Development](#development)
- [Prerequisites](#prerequisites)
- [Live development build](#live-development-build)
- [Building](#building)
- [Usage](#usage)
- [List of Commands](#list-of-commands)
- [Contributing](#contributing)
- [Contact](#contact)
- [Acknowledgments](#acknowledgments)
## About The Project
Spotlightify is a GUI based application designed to allow users to quickly interact with Spotify playback
across Windows, Linux and macOS. Created with simplicity and efficiency in mind, Spotlightify allows users to
seamlessly control their music experience without having to navigate through Spotify's native interface.
https://github.com/user-attachments/assets/77118ce9-cb8c-443f-9008-b1cd8817db74
### Built With
- [![Wails][Wails.com]][Wails-url]
- [![Go][Go.com]][Go-url]
- [![React][React.js]][React-url]
- [![Tailwind][Tailwind.com]][Tailwind-url]
- [![Vite][Vite.com]][Vite-url]
## Development
Spotlightify is currently in development and could benefit from your help!
If you are interested in testing Spotlightify, please follow the instructions below to get started.
Development of this application is currently taking place on macOS, so Windows and Linux users may experience issues.
### Prerequisites
- Go `1.22.5` or later
- Node.js `20.11.1`
- NPM `10.24.0`
- Wails `2.0.0` or later
- Spotify Premium Account
- Spotify API Application, instructions can be found [here](https://spotlightify.github.io/setup)
### Live development build
To run in live development mode, run the following command in the project directory:
```shell
wails dev
```
### Building
To build a redistributable, production mode package, run the following in the project directory:
```shell
wails build
```
## Usage
The GUI is activated by using the shortcut `control + alt + space` for Windows and Linux, and `control + option + space` for macOS.
Here is the current list of available functions:
### List of Commands
```
| Name | Description | Keyword |
|------------------|----------------------------------------------------|-------------------|
| Play | Find and play a song | play |
| Queue | Find and queues a song | queue |
| Playlist | Find and play a saved/followed playlist | playlist |
| Album | Find and play a saved album | album |
| Artist | Find and play songs from a saved/followed artist | artist |
| Liked | Plays saved/liked music | liked |
| Volume | Changes music volume | volume |
| Go to | Seeks a position in a song | goto |
| Resume | Resumes music playback | resume |
| Skip | Skips the current song | next |
| Previous | Plays pervious song | previous |
| Pause | Pauses music playback | pause |
| Shuffle | Toggles shuffle playback | shuffle |
| Device | Select device for music playback | device |
| Repeat | Toggles repeating modes | repeat |
| Current Playing | Provides currently playing song info and sharing | currently playing |
| Authenticate | Authenticate with Spotify | Authenticate |
| Exit | Exits the application | exit |
```
## Contributing
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
Join us on [discord](https://discord.gg/nrDke3q) to learn more about contributing to the project.
## Contact
Please report any bugs or possible feature requests in the Issues section of this GitHub repository.
Any more general discussions regarding Spotlightify can be directed to the Discussions section of this repository.
To learn more about Spotlightify, feel free to join our [discord server](https://discord.gg/nrDke3q).
## Acknowledgments
- [Wails React Typescript Project Base](https://github.com/hotafrika/wails-vite-react-ts-tailwind-template)
[contributors-shield]: https://img.shields.io/github/contributors/spotlightify/spotlightify.svg?style=for-the-badge
[contributors-url]: https://github.com/spotlightify/spotlightify/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/spotlightify/spotlightify.svg?style=for-the-badge
[forks-url]: https://github.com/spotlightify/spotlightify/network/members
[stars-shield]: https://img.shields.io/github/stars/spotlightify/spotlightify.svg?style=for-the-badge
[stars-url]: https://github.com/spotlightify/spotlightify/stargazers
[issues-shield]: https://img.shields.io/github/issues/spotlightify/spotlightify.svg?style=for-the-badge
[issues-url]: https://github.com/spotlightify/spotlightify/issues
[license-shield]: https://img.shields.io/github/license/spotlightify/spotlightify.svg?style=for-the-badge
[license-url]: https://github.com/spotlightify/spotlightify/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/LinkedIn-%230A66C2?style=for-the-badge&logo=linkedin&logoColor=ffffff
[linkedin-url]: https://linkedin.com/in/peter-g-murphy
[discord-shield]: https://img.shields.io/badge/Discord-%235865F2?style=for-the-badge&logo=discord&logoColor=ffffff
[discord-url]: https://discord.gg/nrDke3q
[product-screenshot]: images/screenshot.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
[Vue-url]: https://vuejs.org/
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com
[Go.com]: https://img.shields.io/badge/Go-Go%20Programming%20Language?style=for-the-badge&logo=Go&logoColor=FDDD00&color=000000
[Go-url]: https://go.dev/
[Wails.com]: https://img.shields.io/badge/Wails-wails?style=for-the-badge&logo=wails&logoColor=dd3633&color=ffffff
[Wails-url]: https://wails.io/
[Vite.com]: https://img.shields.io/badge/Vite-8bc6fc?style=for-the-badge&logo=vite
[Vite-url]: https://vitejs.dev/
[Tailwind.com]: https://img.shields.io/badge/Tailwind%20CSS-%23399951?style=for-the-badge&logo=tailwindcss
[Tailwind-url]: https://tailwindcss.com/
