Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cephalization committed Sep 19, 2024
1 parent b8ee86f commit 1f2dd4a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,44 @@

![Playlist Cloud Visualizer](./assets/image.png)

## Features

- Visualize your Spotify playlists in 3D space
- Re-arrange the tracks in space to your liking, based on Spotify's audio analysis
- View track information on hover, or click
- Preview songs directly in the app

Future feature ideas:

- Split playlists into multiple smaller playlists based on cloud clusters
- Filter point cloud by track attributes
- Improve visuals and interactivity
- Pagination of playlists as well as tracks on a playlist
- Currently, the app can handle up to 100 tracks in a playlist, and 100 playlists per user

## Development

Run the dev server:

```sh
npm run dev
pnpm install
cp .env.example .env
# edit .env with your Spotify API credentials
# get Spotify app credentials here: https://developer.spotify.com/dashboard/application
# Use the default callback URL inside of .env.example when configuring your Spotify app
pnpm run dev
```

## Deployment

First, build your app for production:

```sh
npm run build
pnpm run build
```

Then run the app in production mode:

```sh
npm start
```
pnpm start
```
Binary file modified assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1f2dd4a

Please sign in to comment.