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

@weareenvoy/gatsby-source-mvdb

v1.0.5

Published

A minimal source plugin for a generic database

Downloads

20

Readme

Gatsby Source Maavee Database

A minimal source plugin to source specific 'Brand' data for the Maavee e-commerce store.

A minimal boilerplate for the essential files Gatsby looks for in a plugin.

Built from gatsby-starter-plugin

Usage

  1. Install npm package.
npm i @weareenvoy/gatsby-source-mvdb
  1. Update the gatsby-config.js of your gatsby project (where this plugin will be used) and include the plugin in the plugins array.:
cd path-to-some-gatsby-project
module.exports = {
  plugins: [
    // other gatsby plugins
    // ...
    {
			resolve: '@weareenvoy/gatsby-source-mvdb',
			options: {
				api_base_url: process.env.MV_DB_URL,
				token: process.env.MV_DB_TOKEN,
			},
		},
  ],
}

Sample .env file

MV_DB_URL="XXX"
MV_DB_TOKEN="XXX"
  1. Verify the plugin was added correctly

You can verify your plugin was added to your site correctly by running gatsby develop for the site.

You should now see a message logged to the console in the preinit phase of the Gatsby build process:

$ gatsby develop
...
Loaded gatsby-source-mvdb
...
BUILDING NODES FOR (X) BRANDS!
...

If the above was successful you will also see allBrand in GraphiQL at http://localhost:8000/___graphql

Contributing

You may point your GatsbyJS project to a local copy of this plugin and test your updates. The usage is the same as described above with the difference of pointing to your local copy within your gatsby-config.js file.

  1. Clone (or download) the repo and install npm packages.
git clone [email protected]:weareenvoy/gatsby-source-mvdb.git
cd gatsby-source-mvdb
npm install
  1. Go to the project that will use this plugin and update gatsby-config.js to point to your local copy of the plugin. Notice the line require.resolve('<path-to>/gatsby-source-mvdb') where you specify the path to the plugin root folder:
module.exports = {
  plugins: [
    // other gatsby plugins
    // ...
    {
			resolve: require.resolve(`../gatsby-source-mvdb`),
			options: {
				api_base_url: process.env.MV_DB_URL,
				token: process.env.MV_DB_TOKEN,
			},
		},
  ],
}

Make sure you have the required .env variables as described in the Usage section.

Directory Structure

The main files being used are as follows:

gatsby-node.js Implements Gatsby sourceNodes API and calls functions in the next file, which handles the API calls.

api.js Makes REST call to the client provided URL where they store their Brand data.