spotify-playlist-manager

KO | EN

gitlite — search

#python #javascript #nodejs #react #flutter #android #opencv #mongodb #typescript #deep-learning #flask #websocket

spotify-playlist-manager

★ 20 Open GitHub ↗

A website designed for Spotify users to manipulate and manage their playlists in new and exciting ways.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Spotify Playlist Manager
### Live at www.spotifyplaylistmanager.net
Spotify Playlist Manager (SPM for short) is a website designed to utilize playlists in ways Spotify does not natively support. It is for Spotify users trying to get the most out of their playlists and feel limited by what is available.

# Tools
### Multiple Playlist Searcher
This tool looks through your saved playlists for a chosen song and tells you which playlists contain the song.

### True Random Shuffle
This tool creates a copy of the selected playlist but with the song ordering shuffled in a purely random manner.

### Playlist Set Operations
This tool creates a new playlist based on two or more other playlists using [set operations](https://en.wikipedia.org/wiki/Set_(mathematics)#Basic_operations):

i.e. an intersection would create a playlist containing only songs that are in both playlists

# Installation for Development
`npm install`

Run this command in both the /client and /server directories to install the neccessary npm packages.

# Installation for Production Server

Steps were used to install on Ubuntu 22.04. Trying to install on a different OS/Distro might cause unexpected problems.

## Needed:
- Nginx
    - proper configuration file setup
- Certbot
    - works with nginx to update certs when needed
- Docker and Docker-Compose
    - used now for installing server side dependencies with ease
- PM2
    - setup node process to be monitored and started up by pm2
    - install: `npm install pm2@latest -g`
- PostgreSQL
    - used for general long term storage
- Redis
    - used for worker queues

1. Install nginx, certbot, docker, docker-compose, and pm2
2. Include two .env files, 1 in `/client` and one in `/server` with appropriate env fields
3. Build `/client`
4. Link `/client/build` to `/var/www/spotify-playlist-manager` to be used as the root in nginx config
5. Install `spm-nginx.conf` to `/etc/nginx/sites-enabled` and `/etc/nginx/sites-available`
6. Use certbot to configure and add relevant config to those blocks
7. Get certs for the domain names
8. Start up docker image with `npm run start` in `/server`
9. Install .env files into `/client` and `/server` folders with relevant fields

# PostGreSql Database Setup

Docker handles the creation of the database, to change the schema, modify `spm.sql` and restart the container.

# ENV Configs
### /client
REACT_APP_PUBLIC_URL: Where the React site is being run

REACT_APP_API_URL: Where Node.js server is being run

### /server
#### [Spotify API](https://developer.spotify.com/documentation/web-api/quick-start/)
CLIENT_ID: Spotify API Client Id

CLIENT_SECRET: Spotify API Client Secret

REDIRECT_URI: Spotify redirects to this after login. Would recommend using `http://localhost:3001/auth/callback`

#### [Database](https://node-postgres.com/features/connecting)
DB_USER: User of database.

DB_HOST: Where database is being run. Likely `localhost`

DB_NAME: Name of database

DB_PASSWORD: Password of database

DB_PORT: Port database is running on

SESSION_SECRET: Secure string used for [express-session](https://www.npmjs.com/package/express-session)

STALE_DATA_TIMEOUT: Used to determine when to refresh database. Would recommend `3600000` ms (1 hour)

#### Misc
PORT: Port of Node.js Server. Would recommend `3001`

ORIGIN_URL: Url of Front-end. Would recommend `http://localhost:3000`

SERVER: Either 'dev' or 'prod'. Used for error messages that get returned to client.

# Running
`npm start`

Run this command in both the /client and /server directories to start up the front-end and back-end servers respectively.

You should then go to <http://localhost:3000>.

# Special Thanks

I just wanted to thank a couple people for helping debug and test the website as I developed it. Without their support, it would've been much, much harder to catch and fix bugs once the website was fully live.

- Justin Kwon
- Saba Zerefa
- Justin Witherspoon
- Edward McKeown
- Josh Barbell
- Ryan McLaughlin

# Attribution
- Music icon by HAZHA FARASYA from <a href="https://thenounproject.com/browse/icons/term/music/" target="_blank" title="Music Icons">Noun Project</a> (CC BY 3.0)

spotify-playlist-manager

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README