Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated readme #6

Merged
merged 1 commit into from
Oct 8, 2022
Merged

updated readme #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,41 @@ error response:
"message": "lyrics for this track is not available on spotify!"
}
```

## Deployment

> Want to host your own version of this API, But first you need SP_DC cookie from spotify

__Find SP_DC__

You will find the detailed guide [here](https://github.com/akashrchandran/syrics/wiki/Finding-sp_dc).

__Heroku__


[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://dashboard.heroku.com/new?template=https://github.com/akashrchandran/spotify-lyrics-api)

__Run locally__

> use git to clone the repo to your local machine or you can download the latest [zip](https://github.com/akashrchandran/spotify-lyrics-api/archive/refs/heads/main.zip) file and extract it.

*You need to have PHP installed on you machine to run this program.*

__Enter into the folder via terminal__
```sh
cd spotify-lyrics-api
```
__Set SP_DC token as environment variable temprorily__

```sh
export SP_DC=[token here and remove the square brackets]
```

__Start the server__
```
php -S localhost:8000
```
now open your browser and type `localhost:8080` and you should see the program running.
## Credits

• [Me](https://akashrchandran.in)
Expand Down