AlexInABox / unify-music-rpc

A website showing your latest ytmusic stream and youtube video!

unify-music-rpc

unify-music-rpc - built for myself, but you can use it too!
Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
   • Daemonize
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Getting Started

Funny project. Easy to use!

Prerequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
6.4.1
v8.16.0

(your output should look something like this if and only if you have those tools installed. if not, consider installing them! duh)

Installation

1. Clone the repo into the websites root directory

   git clone https://github.com/alexinabox/unify-music-rpc

2. Navigate to the directory

   cd unify-music-rpc

3. Install NPM packages

   npm install

4. start the script and watch the initial output:

   node index.js

5. the script will ask you to visit a google oauth page and to enter the provided code. (do that)

6. now you are logged in and cached your credentials. this action will must only be performed once every couple of months.

7. keep the script running in the background. (i suggest using a tool like pm2 reffered to in the next section)

(back to top)

Daemonize

The daemonization of this application ensures that it always runs in the background and also starts itself on boot!

!!! WARNING !!! Before you deamonize this application, make sure to at least run unify-music-rpc once on your machine using the commands above!

0. Navigate into the unify-music-rpc directory and install PM2:

   npm install pm2@latest -g

   or

   yarn global add pm2

1. Start the application with PM2:

   pm2 start index.js --name "unify-music-rpc"

2. Save the process list so that PM2 can automatically restart your app on reboot:

   pm2 save

3. To monitor all of your processes:

   pm2 monit

(back to top)

Roadmap

• better dynamic backround (just like apple music)
• api endpoint for other applications to use
• turing machine
  • my teacher would love it!

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Bla Bla Bla learning bla bla bla open-source bla bla bla 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 (write something neat so i know whats goin on)

(back to top)

License

Distributed under the GNU General Public License v3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

AlexInABox - @wilder_Alex__ - [e-mail]

Project Link: https://github.com/alexinabox/unify-music-rpc

Website: https://alexinabox.de

Example Page: https://alexinabox.de/music/

(back to top)

Acknowledgments

• DALL-E 2 for the awesome logo
• GitHub Copilot for always being there for me

(back to top)