-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(backend): remove the google books API key
- Loading branch information
Showing
4 changed files
with
32 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Books | ||
|
||
A guide about books integration for Ryot. | ||
|
||
## Integration with Google Books | ||
|
||
Ryot also supports tracking books via [Google Books](https://books.google.com). However, | ||
the API is heavily rate limited, so it is not possible to hardcode the API keys in the | ||
application (unlike the others). | ||
|
||
You can follow the below steps to obtain your own API keys and enable book tracking with | ||
Google Books. | ||
|
||
### Steps | ||
|
||
1. Create a [Google Cloud Platform](https://cloud.google.com) account. Open your [Google | ||
Cloud Platform Console](https://console.cloud.google.com). | ||
|
||
2. Use the default project or click on "Create a project" on the dashboard. | ||
|
||
3. Open the [APIs & Services Dashboard](https://console.cloud.google.com/apis/dashboard). | ||
|
||
4. Click on "Enable APIs and Services". Search for "Google Books API" and click on | ||
"Enable". | ||
|
||
5. Click on "Credentials" on the left sidebar. Click on "Create Credentials" and select | ||
"API key". | ||
|
||
6. Click on "Create" and copy the API key. | ||
|
||
7. Set the `books.google_books.api_key` configuration variable in the environment as | ||
described in the [configuration](../configuration.md#important-parameters) docs. |