npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@balsick/gatsby-source-goodreads

v0.3.4

Published

Get the public shelves and books for a Goodreads user for use in Gatsby.

Downloads

4

Readme

gatsby-source-goodreads

Source plugin for pulling your shelved books into Gatsby from Goodreads API.

How to use

Install the plugin

npm i @balsick/gatsby-source-goodreads

Then configure the plugin in gatsby-config.js

// In your gatsby-config.js
module.exports = {
  plugins: [
    {
      resolve: "@balsick/gatsby-source-goodreads",
      options: {
        developerKey: "IAmDeveloperKey",
        goodReadsUserId: "IAmGoodreadsUserId",
        userShelf: "to-read" //optional
        userShelves: ['to-read','currently-reading','custom-shelf',...] //optional
      }
    }
  ],
}

Plugin options

  • developerKey: Use your Goodreads developer API key
  • goodReadsUserId: The Goodreads user ID of the user to get data for.
  • userShelf: OPTIONAL. read, currently-reading, to-read, etc.
  • userShelves: OPTIONAL. An array containing the names of the shelves to query.

If neither userShelf nor userShelves are set, all the user shelves are queried.

How to query your Goodread data using GraphQL

Below is a sample query for fetching the shelf's books.

query goodRead {
  goodreadsShelves {
    goodreadsShelf {
      shelfName
      reviews {
        book {
          title
          smallImageUrl
          link
          description
        }
        dateAdded
        rating
      }
    }
  }
}

You can query all the set shelves, some shelves only or a single shelf. For querying a single shelf, a query like this can be used.

query goodRead {
  goodreadsShelf(shelfName: {eq: "to-read"}) {
    shelfName
    reviews {
      reviewID
      rating
      votes
      spoilerFlag
      spoilersState
      dateAdded
      dateUpdated
      book {
        bookID
      }
    }
  }
}