Skip to content

Latest commit

 

History

History
97 lines (59 loc) · 1.94 KB

README.md

File metadata and controls

97 lines (59 loc) · 1.94 KB

SoundCloud GitHub Profile

Share what you've been listening to on your github profile with this dynamic SVG that showcases one of your recently liked tracks.

Inspired by spotify-github-profile, but built for SoundCloud.


Demo


Deploy Your Own using Vercel

You must deploy your own instance to use this reliably.

1. Fork this repository


2️. Deploy to Vercel

Option A — One-click deploy (recommended)

Click the button below:

Deploy with Vercel

Follow the prompts and deploy.

Option B — Manual deploy (CLI)

npm install -g vercel
vercel login
vercel --prod

3️. Get your endpoint URL

After deployment, Vercel will give you a URL like:

https://your-project-name.vercel.app

Your SVG endpoint will be:

https://your-project-name.vercel.app/api/soundcloud

Use in Your GitHub README

<img src="https://your-project-name.vercel.app/api/soundcloud?user=YOUR_SOUNDCLOUD_USERNAME&pool=11" />

Parameters

Parameter Description
user Required. Your SoundCloud username
pool Optional. Number of liked tracks to sample from (max: 10)

Important Notes

SoundCloud limitations

  • Public SoundCloud pages only expose 10 liked tracks
  • pool values above 10 are automatically clamped

Local Development

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
vercel dev

Then open:

http://localhost:3000/api/soundcloud?user={YOUR_USERNAME}