Skip to content

Commit 5f881a8

Browse files
committed
new env docs
1 parent f649472 commit 5f881a8

1 file changed

Lines changed: 15 additions & 22 deletions

File tree

README.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# LibreNote
2-
32
## Installation & Hosting Guide
43

54
1. [Create a Discord application](https://discord.com/developers/applications) (discord bot).
@@ -9,22 +8,14 @@
98
* Add the bot to the servers you want it to be in.
109
* https://discord.com/api/oauth2/authorize?client_id=CLIENTID&permissions=8&scope=bot%20applications.commands
1110
* Replace `CLIENTID` in the link with the *APPLICATION ID* from *General Information*.
12-
2. [Get a YouTube API key](https://developers.google.com/youtube/v3/getting-started) & enable the YouTube API.
13-
* You will require a [Google Account](https://www.google.com/accounts/NewAccount).
14-
* Go to the [Google Developer Console](https://console.developers.google.com/)
15-
* Agree to the terms of service.
16-
* Select *AGREE AND CONTINUE*.
17-
* Select *SKIP*.
18-
* At the top right of your screen, in blue text, select *CREATE PROJECT*.
19-
* Name the project whatever you'd like (e.g. `LibreNote`).
11+
2. [Get a Spotify Client ID & Secret](https://developer.spotify.com/documentation/general/guides/app-settings/#register-your-app).
12+
* You will require a [Spotify Account](https://www.spotify.com/signup).
13+
* Go to your [Spotify Dashboard](https://developer.spotify.com/dashboard/)
14+
* Select *CREATE AN APP*
15+
* Enter an App name and App description.
16+
* Read & agree to the developer terms & branding guidelines.
2017
* Select *CREATE*.
21-
* Wait for the project to complete creation.
22-
* Go to the [YouTube Data API v3](https://console.cloud.google.com/marketplace/product/google/youtube.googleapis.com?q=search&referrer=search&supportedpurview=project) or search `YouTube Data API v3` in the top search bar.
23-
* Select *ENABLE*, if it prompts you for a project to select, select the one you just created and continue.
24-
* Go to the [Credentials page](https://console.cloud.google.com/apis/credentials) or select *Credentials* on the left panel.
25-
* Click *+ CREATE CREDENTIALS* at the top middle-left.
26-
* Select *API key*.
27-
* Have this key ready for use in step 3.
18+
* Have your *Client ID* and *Client Secret* ready for Step 3.
2819

2920
### Docker (Reccomended)
3021
You can run LibreNote with Docker.
@@ -33,12 +24,13 @@ Ensure you have [Docker](https://www.docker.com/) and [Node.js (v16)](https://no
3324
3. Create a file named `librenote.env`, fill it with the following content:
3425
* Copy your bot's **TOKEN** from *Bot* on the left panel and place it after `BOT_TOKEN=`.
3526
* Copy your bot's **APPLICATION ID** from *General Information* on the left panel and place it after `CLIENT_ID=`.
36-
* Copy your YouTube API key created in step 2, and place it after `YT_API_KEY=`.
27+
* Copy your Spotify **Client ID** created in step 2, and place it after `SPOTIFY_CLIENT_ID=`.
28+
* Copy your Spotify **Client Secret** created in step 2, and place it after `SPOTIFY_CLIENT_SECRET=`.
3729
* Save the file.
3830
```env
3931
BOT_TOKEN=
40-
CLIENT_ID=
41-
YT_API_KEY=
32+
SPOTIFY_CLIENT_ID=
33+
SPOTIFY_CLIENT_SECRET=
4234
```
4335
4. Open a command line and run the following commands:
4436
* Install & start Redis with docker:
@@ -81,12 +73,13 @@ Ensure you have [Node.js (v16)](https://nodejs.org/), [Git](https://git-scm.com/
8173
4. Create a file named `.env` in the current directory, fill it with the following content:
8274
* Copy your bot's **TOKEN** from *Bot* on the left panel and place it after `BOT_TOKEN=`.
8375
* Copy your bot's **APPLICATION ID** from *General Information* on the left panel and place it after `CLIENT_ID=`.
84-
* Copy your YouTube API key created in step 2, and place it after `YT_API_KEY=`.
76+
* Copy your Spotify **Client ID** created in step 2, and place it after `SPOTIFY_CLIENT_ID=`.
77+
* Copy your Spotify **Client Secret** created in step 2, and place it after `SPOTIFY_CLIENT_SECRET=`.
8578
* Save the file.
8679
```env
8780
BOT_TOKEN=
88-
CLIENT_ID=
89-
YT_API_KEY=
81+
SPOTIFY_CLIENT_ID=
82+
SPOTIFY_CLIENT_SECRET=
9083
```
9184
9285
5. Enter the command line again and run the following commands.

0 commit comments

Comments
 (0)