docs: 📝 Update documentation

This commit is contained in:
Louis Gallet 2024-07-01 17:27:34 +02:00
parent 2ae758c73e
commit 3f8489b0ad
Signed by: lgallet
GPG Key ID: 84D3DF1528A84511
3 changed files with 8 additions and 4 deletions

View File

@ -1,4 +1,5 @@
client_id=
client_secret=
n8n_webhook=
n8n_webhook_add_tracks=
n8n_webhook_create_playlist=
enviroment=dev

View File

@ -11,12 +11,14 @@ Make This Playlist is a web application that allows anyone to add music to a Spo
### Docker
You can install the application via Docker. To do this, execute the following command:
For the webhook URLs, make sure to remove the parameters, as they will be added directly by the application.
```bash
docker run -d \
-p 80:3000 \
-e client_id=SPOTIFY_CLIENT_ID \
-e client_secret=SPOTIFY_CLIENT_SECRET \
-e n8n_webhook=N8N_WEBHOOK_URL \
-e n8n_webhook_create_playlist=N8N_WEBHOOK_URL \
-e n8n_webhook_add_tracks=N8N_WEBHOOK_URL \
gitea.louisgallet.fr/lgallet/makethisplaylist:latest
```
@ -26,5 +28,6 @@ To install the application manually, clone the repository and install the depend
git clone https://gitea.louisgallet.fr/lgallet/makethisplaylist.git
cd makethisplaylist
pip install -r requirements.txt
cp .env.example .env
python main.py
```

View File

@ -30,7 +30,7 @@
<input type="text" class="form-control" name="roomName" placeholder="Room name" />
<small id="roomNameHelp" class="form-text text-muted">This will be the playlist name</small>
</div>
<button type="submit" class="btn btn-success">Create (require a Spotify account)</button>
<button type="submit" class="btn btn-success">Create</button>
</form>
</div>
</div>