vuthanhtrung2010 / spotify-status

A flexible spotify status with Next.js

Support Server

Important notes and thank ❤️

First of all, thanks for using this Source Code, it was and is a ton of work to create and maintain it! That's why I'm asking everyone to donate a little bit of money (via Paypal through ko-fi) or if that's not possible, then join my Discord Server!

Installation Guide 🔥

✅ Hosting Requirements

Click to expand

• nodejs version 20 or higher, I recommend the latest STABLE version
• A VPS would be advised, so you don't need to keep your PC/Laptop/RasPi 24/7 online!
• At least 2GB of RAM & 0.5 - 0.75vCPU with 2GB storage.

🤖 Website Requirements

Click to expand

1. Download the Source Code
   • Either by: git clone https://github.com/vuthanhtrung2010/spotify-status
   • Or by downloading it as a zip from a branch

🤖 Configuration and Starting

Click to expand

NOTE: You can do the exact same configuration inside of the .env.example file, just make sure to rename it to .env or use environment variables!

1. Ensure that you have installed all node modules by running npm i
2. Ensure that you have renamed .env.example to .env and added environment variables
3. Now run npm run build then run npm start or npm start or pm2 start npm --name Status -- start if you using a VPS to run the website as production mode. You can also run the website as developer mode by npm run dev or pm2 start "npm run dev" --name Status. Might add npx to the prefix of pm2 if you are not using the runtime version!
4. Now go to the /login route and login to your Spotify Account!
5. Enjoy!

❓ Where to get which Api-Key(s)

Click to expand

NOTE: You can do the exact same configuration inside of the .env.example file, just make sure to rename it to .env or use environment variables!

1. ./.env
   • client_secret you can get from: Spotify Developer Dashboard
   • client_id you can get from: Spotify Developer Dashboard
   • redirect_uri whatever you set for your domain/website, route /callback. Eg: https://spotify.trung.is-a.dev/callback
   • DATABASE_URL get from your self hosted database. See full list of supported database by prisma ORM here.
   • email is email that you use to register to Spotify platform.
   • PORT is your port number the website listening to. Default listening port will be 3000.
   • SENTRY_AUTH_TOKEN (optional for who want to track errors/performance): Get it from Sentry Dashboard.
   • SENTRY_DSN_ADDRESS (optional for who want to track errors/performance): Get it from your Sentry project.
   • BASE_URL your base URL. Eg: https://spotify.trung.is-a.dev

Contributing

If you want to help improve the code, fix spelling or design Errors or if possible even code errors, you may create PULL REQUESTS. Please create pull request compare to beta branch, else you will get instant close! Please consider, that Vũ Thành Trung is the main Developer of this project!