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## 馃摝 Prerequisites
11
12- Node.js (v22 or later)
13- Rust
14- Turbo
15- Docker
16- Wasm Pack https://rustwasm.github.io/wasm-pack/installer/
17- DuckDB https://duckdb.org/docs/installation
18
19## 馃殌 Getting Started
20
21> [!IMPORTANT]
22>
23> Self-hosting or running Rocksky locally is still **difficult** at this stage.
24> Parts of the API are still tied to [**Xata Postgres**](https://xata.io), and a full migration to standard **Postgres** is ongoing.
25> Until this migration is complete, expect setup to be non-trivial.
26
27
281. Clone the repository:
29 ```bash
30 git clone https://github.com/tsirysndr/rocksky
31 cd rocksky
32 ```
332. Install dependencies:
34 ```bash
35 npm install -g turbo
36 bun install
37 bun run build:raichu
38 ```
393. Set up the environment variables:
40 ```bash
41 cp apps/api/.env.example apps/api/.env
42 cp .env.example .env
43 # Edit the .env files to add your configurations
44 ```
454. Start the Docker containers:
46 ```bash
47 docker compose up
48 ```
495. Run the database migrations:
50 ```bash
51 turbo db:migrate --filter=@rocksky/api
52 ```
536. Start Analytics API:
54 ```bash
55 turbo dev:analytics
56 ```
577. Start jetstream:
58 ```bash
59 turbo dev:jetstream
60 ```
618. Start the development server:
62 ```bash
63 turbo dev --filter=@rocksky/api --filter=@rocksky/web
64 ```
65
66## 馃摎 Documentation
67[View the full documentation](https://docs.rocksky.app)
68
69## 鉁嶏笍 Feedback
70This repository is the central place to collect feedback and issues related to [Rocksky](https://rocksky.app).
71
72Please [**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)
73
74## 馃 Contributing
75We would love to hear your feedback or suggestions. The best way to reach us is on [Discord](https://discord.gg/EVcBy2fVa3).
76
77We also welcome pull requests into this repo. See [CONTRIBUTING.md](CONTRIBUTING.md) for information on setting up this repo locally.