gatsby-source-itchio's Introduction

gatsby-source-itchio

A source plugin for GatsbyJS to query game information from the itch.io serverside API.

Install

# npm
npm install --save gatsby-source-itchio

#yarn
yarn add gatsby-source-itchio

Then add the following to your gatsby-config.js:

module.exports = {
  /* ... */
  plugins: [
    /* ... */
    {
      resolve: "gatsby-source-itchio",
      options: {
        key: // YOUR_API_KEY
      }
    }
  ]
};

To use this plugin, you'll need a web API key for your itch.io account (get one here).

How to query

See API documentation for the endpoint here.

const gameQuery = `
  query GameQuery {
    allItchioGame(limit: 10) {
      edges {
        node {
          user {
            display_name,
            id,
            url,
            cover_url,
            username
          },
          id,
          url,
          created_at,
          title,
          classification,
          type,
          short_text,
          published,
          published_at,
          views_count,
          can_be_bought,
          min_price,
          purchases_count,
          p_osx,
          p_android,
          p_linux,
          p_windows,
          in_press_system,
        }
      }
    }
  }
`;

gatsby-source-itchio's People

Contributors

Stargazers

Watchers

gatsby-source-itchio's Issues

Need warning for when API key is missing

Add Gatsby peer dependency version

Running into this npm warning when running a command:

npm WARN [email protected] requires a peer of gatsby@ but none is installed. You must install peer dependencies yourself.

I think this could be solved by adding a version to the Gatsby peer dependency of the plugin. Glanced at the package.json and the version is blank. I'm using gatsby@^2.20.3 and it's working great.