Table of Contents
neoplay is an open source, small weekend project aimed at creating a Spotify player with the following goals in mind.
- Must be lightweight (Memory and CPU usage)
- Must be themed for developers (Based on Neofetch and VSCode)
- Must look cool
Disclaimer: This project is very new and if you stumble upon any bugs, please to create an issue for it. :)
- Tauri V2
- SvelteKit
- Rust
- Spotify Web API
- Spotify Playback SDK
- TODO
To get a local copy of neoplay up and running follow these steps.
- Spotify Premium
- Spotify Developer Account
- At the moment, you are required crete your own client ID and secret to log into neoplay. This might change in the future.
The easiest way to start using neoplay is to download the latest executable binary for your OS from the releases page.
After running the downloaded binary, follow the on-screen instructions.
-
Clone the repo
git clone https://github.com/notnavindu/neoplay.git
-
Install the prerequisites (From here)
-
Install NPM packages
# npm npm install # pnpm pnpm install # yarn yarn
-
Start the server
# npm npm tauri dev #pnpm pnpm tauri dev
-
Follow the on-screen instructions
- Log into Spotify Developer Dashboard
- Create an app from the dashboard and use the following settings:
App Name
: NeoplayApp Description
: Anything you likeRedirect URI (*Important)
: http://localhost:5177/callbackWhich API/SDKs are you planning to use (*Important)
: Be sure to enableWeb API
andWeb Playback SDK
- Go to the
Settings
page in your newly created app. - You will see your
clientID
andclientSecret
. These values will be required to log into neoplay.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
TODO.
Distributed under the GNU GPL v3 License. See LICENSE
for more information.
Navindu - @notnavindu
Project Link: https://github.com/notnavindu/neoplay