From aac34763ec030f821e6026bd6cc887282df36d6d Mon Sep 17 00:00:00 2001 From: Louis Gallet Date: Sat, 29 Jun 2024 23:37:06 +0200 Subject: [PATCH] docs: :pencil: Create README Add instructions to clone and execute the project --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..cd71bd8 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# Make This Playlist + +Make This Playlist is a web application that allows anyone to add music to a Spotify playlist without needing a Spotify account. The application is accessible at the following address: [Make This Playlist](https://makethisplaylist.louisgallet.fr). + +## Features +- Creation of a playlist +- Search for music on Spotify +- Add music to a playlist + +## Installation + +### Docker +You can install the application via Docker. To do this, execute the following command: +```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 \ + gitea.louisgallet.fr/lgallet/makethisplaylist:latest +``` + +### Manually +To install the application manually, clone the repository and install the dependencies: +```bash +git clone https://gitea.louisgallet.fr/lgallet/makethisplaylist.git +cd makethisplaylist +pip install -r requirements.txt +python main.py +``` \ No newline at end of file