Skip to content

Commit db243e1

Browse files
committed
chore: add readme
1 parent d4f6ac6 commit db243e1

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1-
# MusicBox
1+
<h1 align="center" id="title">Music Box API</h1>
2+
3+
<p align="center"><img src="https://socialify.git.ci/MusicBoxRaspberryPi/MusicBoxAPI/image?description=1&amp;font=Inter&amp;language=1&amp;name=1&amp;owner=1&amp;theme=Light" alt="project-image"></p>
4+
5+
6+
## 🛠️ Installation
7+
8+
1. Clone the repository `git clone https://github.com/MusicBoxRaspberryPi/MusicBoxAPI`
9+
2. Rename `.env.dist` to `.env`
10+
3. Edit `.env` to your needs
11+
4. Install dependencies `pip install -r requirements.txt`
12+
5. [Create Spotify App](https://developer.spotify.com/dashboard) with redirect URIs: `http://localhost:8080`
13+
6. Copy **Client ID** and **Client Secret** from _Spotify App -> Settings -> View client secret_ to `.env`
14+
7. Run `python -m app.spotify.service`, webpage should open in your browser and `.cache` file should be created
15+
16+
## 🚀 Usage
17+
18+
- With Docker: `docker compose up`
19+
20+
- Without Docker: `python -m app.main`

0 commit comments

Comments
 (0)