Skip to content

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

License

Notifications You must be signed in to change notification settings

AntoineDrouhin/goodreads-box

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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).
  2. Create Goodreads App and copy the Api Key (goodreads.com/api/keys).
  3. Create a new personal access token with the gist scope and copy it (github.com/settings/tokens/new).
  4. Create a new public GitHub Gist (gist.github.com), you can type any random content as placeholder, it will be replaced automatically.

Project setup

  1. Fork this repo.
  2. Go to the repo Settings > Secrets.
  3. 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.

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 97.5%
  • Shell 2.5%