From 1f9a18f8f5a0978a1ae6c218156d763a1b757231 Mon Sep 17 00:00:00 2001 From: Raul Andrade Date: Mon, 14 Mar 2022 21:17:36 -0300 Subject: [PATCH] docs: add quickstart and env to readme --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 821e7ca..71dff2b 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,33 @@ Disclaimer: Randomfy is not affiliated with Spotify. The site was build with Nex This project shows artists and songs based on your Spotify recommendation. When the user signs in the application, a recommendation is shown. The user can like or dislike the recommendation, just like on Tinder. After that, you can make a playlist with the liked artists and share it with your friends. Also, you can create an image with these artists. +## Quickstart + +You can start cloning the repository: + +```bash + +git clone git@github.com:andraderaul/random-fy.git +``` + +Then install all dependencies: + +```bash + +yarn install +``` + +Finally, start the application: + +```bash + +yarn dev +``` + +## Environments + +Important: you must have a spotify developer account with an app created. Then add the `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET` from your app created to `.env`. + ## Todo - [ ] refresh token