https://github.com/vuthanhtrung2010/spotify-status

A flexible spotify status with Next.js
https://github.com/vuthanhtrung2010/spotify-status

nextjs postgres postgres14 postgres16 postgresql postgresql-database prisma prisma-orm sentry spotify spotify-web-api typescript

Last synced: 3 months ago
JSON representation

A flexible spotify status with Next.js

• Host: GitHub
• URL: https://github.com/vuthanhtrung2010/spotify-status
• Owner: vuthanhtrung2010
• Created: 2024-04-11T05:42:26.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2025-03-19T15:31:14.000Z (3 months ago)
• Last Synced: 2025-03-19T16:34:42.257Z (3 months ago)
• Topics: nextjs, postgres, postgres14, postgres16, postgresql, postgresql-database, prisma, prisma-orm, sentry, spotify, spotify-web-api, typescript
• Language: TypeScript
• Homepage: https://spotify.devtrung.tech
• Size: 3.03 MB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# 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**](https://ko-fi.com/devtrung) (via Paypal through ko-fi) or if that's not possible, then join my [Discord Server](https://discord.gg/5q6zxM5vnT)!

# Installation Guide 🔥

## ✅ Hosting Requirements

  Click to expand

- [nodejs](https://nodejs.org) 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](https://github.com/vuthanhtrung2010/spotify-status)

   - 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 `pnpm i`

2.  Ensure that you have renamed `.env.example` to `.env` and added environment variables

3.  Now run `pnpm run build` then run `pnpm start` or `pnpm start` or `pm2 start pnpm --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 `pnpm run dev` or `pm2 start "pnpm 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](https://developer.spotify.com)

   - `client_id` you can get from: [Spotify Developer Dashboard](https://developer.spotify.com)

   - `redirect_uri` whatever you set for your domain/website, route `/callback`. Eg: `https://spotify.devtrung.tech/callback`

   - `DATABASE_URL` get from your self hosted database. See full list of supported database by prisma ORM [here](https://www.prisma.io/docs/orm/reference/supported-databases).

   - `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](https://sentry.io/settings/auth-tokens/).

   - `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.devtrung.tech`

# 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**](https://github.com/vuthanhtrung2010) is the main Developer of this project!