Skip to content

Commit

Permalink
docs: add quickstart and env to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Raul Andrade committed Mar 15, 2022
1 parent 36a33bc commit 1f9a18f
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

1 comment on commit 1f9a18f

@vercel
Copy link

@vercel vercel bot commented on 1f9a18f Mar 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.