t1c.dev
forked from
rocksky.app/rocksky
A decentralized music tracking and discovery platform built on AT Protocol 🎵
tsiry-sandratraina.com
1# Rocksky
2
3[](https://github.com/tsirysndr/rocksky/actions/workflows/ci.yml)
4[](https://discord.gg/EVcBy2fVa3)
5
6A decentralized music tracking and discovery platform built on the AT Protocol 🎵 , see [Rocksky](https://rocksky.app).
7
8
9
10## ✨ Features
11
12### 🎵 Scrobbling APIs
13- **Last.fm Compatible API** – drop-in replacement for Last.fm scrobblers
14- **ListenBrainz Compatible API** – works with clients that support ListenBrainz
15
16### 🕒 Playback & History
17
18- **Recently Played Timeline** – browse your listening history
19- **Stories View** – see what other users are playing in real time
20- **Stats** – visualize scrobbles per day
21
22### 📊 User Insights
23
24- **Top Artists, Tracks, and Albums** – personalized charts of your listening habits
25- **Shoutbox & Likes** – interact with other listeners and share reactions
26
27### 🌐 Client Integrations
28- **Spotify** – detect now playing tracks and scrobble directly from Spotify
29- **Jellyfin** – track plays from your media server
30- **Pano Scrobbler** – Android/Linux/Windows support
31- **WebScrobbler** – scrobble directly from your browser
32
33### 🔍 Search
34- **Search Engine** – fast search powered by MeiliSearch
35
36## 🚧 Coming Soon / Roadmap
37- **Webhooks** - subscribe to scrobble events and integrate with Discord or your own apps
38- **Personalized Feeds** – discover music through community-driven feed algorithms
39- **Last.fm → Rocksky** Mirroring (Future Scrobbles) – automatically mirror new scrobbles from Last.fm into Rocksky
40- **Rocksky Connect** – remote playback across devices (similar to Spotify Connect)
41- **Multi-Source Libraries** – browse and scrobble from Google Drive, Dropbox, S3, FTP, and more
42- **Stream & Scrobble Your Own Music** – upload your library and play directly on Rocksky
43- **Extensions** – customize and extend Rocksky with your own logic
44- **Crossfade & Equalizer Settings Sync** – carry your playback preferences across devices
45
46## 📦 Prerequisites
47
48- Node.js (v22 or later)
49- Rust
50- Turbo
51- Docker
52- Wasm Pack https://rustwasm.github.io/wasm-pack/installer/
53- DuckDB https://duckdb.org/docs/installation
54
55## 🚀 Getting Started
56
57> [!IMPORTANT]
58>
59> Self-hosting or running Rocksky locally is still **difficult** at this stage.
60> Parts of the API are still tied to [**Xata Postgres**](https://xata.io), and a full migration to standard **Postgres** is ongoing.
61> Until this migration is complete, expect setup to be non-trivial.
62
63
641. Clone the repository:
65 ```bash
66 git clone git@tangled.sh:rocksky.app/rocksky
67 cd rocksky
68 ```
692. Install dependencies:
70 ```bash
71 npm install -g turbo
72 bun install
73 bun run build:raichu
74 ```
753. Set up the environment variables:
76 ```bash
77 cp apps/api/.env.example apps/api/.env
78 cp .env.example .env
79 # Edit the .env files to add your configurations
80 ```
814. Start the Docker containers:
82 ```bash
83 docker compose up
84 ```
855. Run the database migrations:
86 ```bash
87 turbo db:migrate --filter=@rocksky/api
88 ```
896. Start Analytics API:
90 ```bash
91 turbo dev:analytics
92 ```
937. Start jetstream:
94 ```bash
95 turbo dev:jetstream
96 ```
978. Start the development server:
98 ```bash
99 turbo dev --filter=@rocksky/api --filter=@rocksky/web
100 ```
101
102## 📚 Documentation
103[View the full documentation](https://docs.rocksky.app)
104
105## ✍️ Feedback
106This repository is the central place to collect feedback and issues related to [Rocksky](https://rocksky.app).
107
108Please [**open an issue**](https://tangled.org/@rocksky.app/rocksky/issues/new) if you want to leave feedback. Feel free to also join our [**Discord server**](https://discord.gg/EVcBy2fVa3)
109
110## 🤝 Contributing
111We would love to hear your feedback or suggestions. The best way to reach us is on [Discord](https://discord.gg/EVcBy2fVa3).
112
113We also welcome pull requests into this repo. See [CONTRIBUTING.md](CONTRIBUTING.md) for information on setting up this repo locally.