neoplay

Table of Contents

1. About The Project
   • Tech Stack
2. Features
3. Getting Started
   • Prerequisites
   • Installation
   • Manual Setup
   • Spotify Account Setup
4. Contributing
5. License
6. Contact

About The Project

neoplay is an open source, small weekend project aimed at creating a Spotify player with the following goals in mind.

1. Must be lightweight (Memory and CPU usage)
2. Must be themed for developers (Based on Neofetch and VSCode)
3. Must look cool

Disclaimer: This project is very new and if you stumble upon any bugs, please to create an issue for it. :)

(back to top)

Tech Stack

• Tauri V2
• SvelteKit
• Rust
• Spotify Web API
• Spotify Playback SDK

Features

• TODO

(back to top)

Getting Started

To get a local copy of neoplay up and running follow these steps.

Prerequisites

• 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.

Installation

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.

Manual Setup

1. Clone the repo

   git clone https://github.com/notnavindu/neoplay.git

2. Install the prerequisites (From here)

3. Install NPM packages

   # npm
   npm install
   
   # pnpm
   pnpm install
   
   # yarn
   yarn

4. Start the server

    # npm
    npm tauri dev
   
    #pnpm
    pnpm tauri dev

5. Follow the on-screen instructions

(back to top)

Spotify Account Setup

1. Log into Spotify Developer Dashboard
2. Create an app from the dashboard and use the following settings:
   1. App Name: Neoplay
   2. App Description: Anything you like
   3. Redirect URI (*Important): http://localhost:5177/callback
   4. Which API/SDKs are you planning to use (*Important): Be sure to enable Web API and Web Playback SDK
3. Go to the Settings page in your newly created app.
4. You will see your clientID and clientSecret. These values will be required to log into neoplay.

Contributing

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!

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

(back to top)

Benchmarks

TODO.

(back to top)

License

Distributed under the GNU GPL v3 License. See LICENSE for more information.

(back to top)

Contact

Navindu - @notnavindu

Project Link: https://github.com/notnavindu/neoplay

(back to top)