Skip to content

Commit

Permalink
Update ENV Formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@Prem-ium
Prem-ium authored Aug 6, 2023
1 parent 1dfcd88 commit 444fd46
Showing 1 changed file with 15 additions and 19 deletions.
34 changes: 15 additions & 19 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,24 @@
## Environment Variables
To run this project, you will need to add the following environment variables to your .env file (see .env.example for a reference):
##### Required .env:
`CLIENT_ID`: [Found on Spotify Developer Dashboard](https://developer.spotify.com/dashboard/)

`SECRET_CLIENT_ID`: [Found on Spotify Developer Dashboard](https://developer.spotify.com/dashboard/)

`REDIRECT_URL`: The Redirect URL you added when creating the App on Spotify's Developer Dashboard. Check .env.example for reference.

`USERNAME`: Your Spotify account username [can be found in Spotify account settings.](https://www.spotify.com/us/account/overview/?utm_source=spotify&utm_medium=menu&utm_campaign=your_account))
| Environment Variable | Description | Default Value |
|------------------------|------------------------------------------------------------------------------------------------------------------------|---------------|
| `CLIENT_ID` | Found on Spotify Developer Dashboard. [More Info](https://developer.spotify.com/dashboard/) | - |
| `SECRET_CLIENT_ID` | Found on Spotify Developer Dashboard. [More Info](https://developer.spotify.com/dashboard/) | - |
| `REDIRECT_URL` | The Redirect URL you added when creating the App on Spotify's Developer Dashboard. Check .env.example for reference. | - |
| `USERNAME` | Your Spotify account username (can be found in Spotify account settings.) | - |

##### Optional .env:
`MINUTES`: Number of minutes the program should wait before updating Top Tracks playlist. Defaults to 360 minutes (or 6 hours).

`PUBLIC_PLAYLIST`: Boolean value indicating whether to create a public playlist. Defaults to True.

`RECOMMENDATIONS`: Boolean value indicating whether to generate recommendations (tracks playlist and artists recommendations). Defaults to False.

`KEEP_ALIVE`: Whether to run the flask server or not to keep program from sleeping on replit. Defaults to False.

`APPRISE_ALERTS`: Full list of services and their URLs available here: [found here on Apprise wiki](https://github.com/caronc/apprise/wiki).

`TZ`: Your desired Time-Zone. Should be formatted from the [IANA TZ Database](https://www.iana.org/time-zones). Defaults to `America/New York`
| Environment Variable | Description | Default Value |
|------------------------|------------------------------------------------------------------------------------------------------------------------|------------------------------------|
| `MINUTES` | Number of minutes the program should wait before updating Top Tracks playlist. | 360 minutes (or 6 hours) |
| `PUBLIC_PLAYLIST` | Boolean value indicating whether to create a public playlist. | True |
| `RECOMMENDATIONS` | Boolean value indicating whether to generate recommendations (tracks playlist and artists recommendations). | False |
| `KEEP_ALIVE` | Whether to run the flask server or not to keep the program from sleeping on replit. | False |
| `APPRISE_ALERTS` | Full list of services and their URLs available here: [Apprise Wiki](https://github.com/caronc/apprise/wiki) | - |
| `TZ` | Your desired Time-Zone. Should be formatted from the IANA TZ Database. | `America/New York` |
| `GSPREAD_KEYS` | Your Google Service Account JSON contents obtained via OAuth 2.0 Client ID in Credentials of Google Cloud API. | - |

`GSPREAD_KEYS`: Your Google Service Account JSON contents obtained via OAuth 2.0 Client ID in Credentials of Google Cloud API.


## Setup
Expand Down

0 comments on commit 444fd46

Please sign in to comment.