npmpackage.info

Gathering detailed insights and metrics for gatsby-source-dogapi

gatsby-source-dogapi

Gatsby source plugin to add thedogapi.com datas to your website

2.0.0-beta.1

MIT

JavaScript

129.00 B

738 1.7

Installations

npm install gatsby-source-dogapi

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

10.4.0

NPM Version

6.3.0 Score

62.4

Supply Chain

96.1

Quality

74.9

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Should target Gatsby v2

2.0.0-beta.01

Updated on Aug 11, 2018

View All 1 releases

Contributors

Unable to fetch Contributors

View All 1 Contributors

Languages

JavaScript

JavaScript (100%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

Manoz

Download Statistics

Total Downloads

738

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

2 Commits

1 Watchers

1 Branches

1 Contributors

Updated on Aug 11, 2018

Bundle Size

142.00 B

Minified

129.00 B

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.0.0-beta.1

Package Id

gatsby-source-dogapi@2.0.0-beta.1

Unpacked Size

96.38 kB

Size

26.53 kB

File Count

NPM Version

6.3.0

Node Version

10.4.0

Total Downloads

Cumulative downloads

Total Downloads

738

Last Day

Compared to previous day

Last Week

Compared to previous week

Last Month

-77.8%

Compared to previous month

Last Year

-6.3%

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

node-fetch query-string

Dev Dependencies

babel-cli babel-eslint babel-preset-env babel-runtime eslint eslint-config-airbnb eslint-config-airbnb-base eslint-plugin-import

gatsby-source-dogapi

The doggy source plugin you'll love.

🐕 Introduction

gatsby-source-dogapi is a simple Gatsby source plugin to add thedogapi.com doggy features to your Gatsby website.

This source plugin lack of features right now but you can use it to play with the API and get random dog pictures. I'll add more options as soon as I can.

Prerequisites

The Dog API is a free service and you can play with it without the needs for an API key.

However if you want to play with more datas, you'll need to signup here and get your API key ready for the next steps.

☕️ Installation Guide

Install Gatsby
Install the plugin using yarn add -D gatsby-source-dogapi or npm i -D gatsby-source-dogapi
Configure the plugin in gatsby-config.js file:

1module.exports = {
2  siteMetadata: {
3    title: 'Wow! Such site! Very title',
4  },
5  plugins: [
6    {
7      resolve: "gatsby-source-dogapi",
8      options: {
9        "limit": 10,
10        "page": 0,
11        "order": "DESC",
12        "x-api-key": "YOUR_API_KEY",
13      },
14    },
15    'gatsby-plugin-offline',
16  ],
17}

📖 Usage

This source plugin supports all options present within the Dog API but you can only get images for now. Here's the options you can use:

Option	Default	Description
limit	1	[Optional] number of images to return valid 1 to 10
page	0	[Optional] only works if account_id is present to page through your own uploads
order	DESC	[Optional] only works if account_id is present, either ASC or DESC - ascending or descending
x-api-key	null	[Optional] your API key (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Get more documentation about The Dog API here.

How to Query

To query 10 random images:

{
  allDogApiPic {
    edges {
      node {
        id
        url
        sub_id
        created_at
        original_filename
      }
    }
  }
}

To query 1 random image:

{
  allDogApiPic(limit: 1) {
    edges {
      node {
        id
        url
        sub_id
        created_at
        original_filename
      }
    }
  }
}

Example output:

1{
2  "data": {
3    "allDogApiPic": {
4      "edges": [
5        {
6          "node": {
7            "id": "22ae1251-42f1-55b7-835a-77b59115b76c",
8            "url": "https://cdn2.thedogapi.com/images/Skx45T6EQ.gif",
9            "sub_id": "tumblr_o6kk05nXYJ1tlb56zo1_400.gif",
10            "created_at": "2018-07-31T11:38:15.000Z",
11            "original_filename": "tumblr_o6kk05nXYJ1tlb56zo1_400.gif"
12          }
13        }
14      ]
15    }
16  }
17}

Here's a link to your localhost query.

License

Released under the MIT license.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-03-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More