@gramps/data-source-xkcd

GrAMPS GraphQL data source to load xkcd comics.

Stats

StarsIssuesVersionUpdatedCreatedSize
@gramps/data-source-xkcd
12332.0.04 years ago4 years agoMinified + gzip package size for @gramps/data-source-xkcd in KB

Readme

GrAMPS · An easier way to manage the data sources powering your GraphQL server

GrAMPS GraphQL Data Source for xkcd

license npm version Build Status Maintainability Test Coverage Greenkeeper badge

Load the latest xkcd comic, or look one up by its ID.

This is a GrAMPS data source for GraphQL.

Example Queries

To get all available fields for this data source, try out these two queries in GraphiQL. (See the quickstart for details on starting GraphiQL.)

query getLatestComic {
  getLatestComic {
    ...ComicFields
  }
}

query getComicById($id: ID!) {
  getComicById(id: $id) {
    ...ComicFields
  }
}

fragment ComicFields on XKCD_Comic {
  num
  title
  safe_title
  img
  alt
  transcript
  year
  month
  day
  link
  news
}

Use the following arguments:

{
  "id": 1900
}

Quickstart

# Clone the repo
git clone git@github.com:gramps-graphql/data-source-xkcd.git

# Move into it
cd data-source-xkcd/

# Install dependencies
yarn install

To Develop with Mock Data

Start the app with the following command:

# Develop with mock data
yarn dev:mock-data

Open the URL displayed in your console to see GraphiQL.

To Develop with Live Data

Once you’ve got your data source configured to load live data, you can enable live data in development:

# Develop with live data
yarn dev

Open the URL displayed in your console to see GraphiQL.

Notes for Developers

Currently, there is no watch capability (PRs welcome!), so the service needs to be stopped (control + C) and restarted (yarn [dev:mock-data|dev]) to reflect new changes to the data source.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.