https://github.com/mdluo/goodreads-box

📚 Update a pinned gist to show your currently reading books and progress on Goodreads
https://github.com/mdluo/goodreads-box

books gist goodreads pinned-gist reading

Last synced: 6 days ago
JSON representation

📚 Update a pinned gist to show your currently reading books and progress on Goodreads

• Host: GitHub
• URL: https://github.com/mdluo/goodreads-box
• Owner: mdluo
• License: mit
• Created: 2020-08-14T12:22:36.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-17T20:00:33.000Z (almost 4 years ago)
• Last Synced: 2024-08-02T07:09:22.978Z (3 months ago)
• Topics: books, gist, goodreads, pinned-gist, reading
• Language: TypeScript
• Homepage:
• Size: 30.3 KB
• Stars: 24
• Watchers: 1
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-pinned-gists - goodreads-box - Update a pinned gist to show your currently reading books and progress on Goodreads. (External Services)

README

        


  

  
goodreads-box

  
Update a pinned gist to show your currently reading books and progress on Goodreads


---

> 📌✨ For more pinned-gist projects like this one, check out: https://github.com/matchai/awesome-pinned-gists

## Setup

### Prep work

1. Create a Goodreads account ([goodreads.com/user/sign_in](https://www.goodreads.com/user/sign_in)).

1. Create Goodreads App and copy the Api Key ([goodreads.com/api/keys](https://www.goodreads.com/api/keys)).

1. Create a new personal access token with the `gist` scope and copy it ([github.com/settings/tokens/new](https://github.com/settings/tokens/new?scopes=gist&description=goodreads-box)).

1. Create a new public GitHub Gist ([gist.github.com](https://gist.github.com/)), you can type any random content as placeholder, it will be replaced automatically.

### Project setup

1. Fork this repo.

1. Go to the repo Settings > Secrets.

1. Add the following environment variables:

    - **GOODREADS_API_KEY**: The Goodreads App Api Key.

    - **GOODREADS_USER_ID**: Your Goodreads account id, can be found in the profile page url e.g. `https://www.goodreads.com/user/show/`**`118339107`**`-mdluo`

    - **BOOKS_SORT_BY**: Optional, default value is `date` which means sort books by update time. Another valid value is `percent`, sort book by read percentage.

    - **GH_TOKEN**: The GitHub personal access token generated above.

    - **GIST_ID:** The ID portion from your new created gist url: `https://gist.github.com/mdluo/`**`f890a4d178012c5a3c5c29ff743a84e8`**.

1. Go to repo Actions, select "Update gist" from the left side and click the "Run workflow" button on the right side. From now on it will be running automatically by the GitHub Actions every 8 hours. Update the `- cron: "0 */8 * * *"` in `.github/workflows/schedule.yml` to change the frequency of the workflow trigger to meet your own needs.