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

@koopjs/provider-github

v3.0.0

Published

Github provider for Koop

Downloads

37

Readme

koop-github

Github provider for Koop

npm travis

Take GeoJSON from a Github repository and serve it as an ArcGIS Feature Service, CSV, KML, or Shapefile.

Install

Koop providers require that you first install Koop. For information on using Koop, see https://github.com/koopjs/koop.

You can add koop-github to your Koop server's dependencies by installing it with npm and adding it to your package.json like so:

npm install koop-github --save

Usage

Make sure your koop configuration includes a github access token (ghtoken in the config object passed to koop or KOOP_GITHUB_TOKEN as an environmental variable). Your Github API requests will be rate limited and you will not have access private gists if you don't include a token.

var koop = require('koop')({
  'ghtoken': 'XXXXXX' // defaults to `process.env.KOOP_GITHUB_TOKEN`
})
var koopGithub = require('koop-github')

koop.register(koopGithub)

koop.server.listen(1338, function () {
  console.log('Listening at http://%s:%d/', this.address().address, this.address().port)
})

Once koop-github is registered as provider and you've started your Koop server, you can request GeoJSON files in Github repositories using this pattern. Note that the path within the repo uses :: as a directory separator:

/github/{organization name}::{repository name}::{folder::path::to::geojson}/FeatureServer/0/query

so for example:

http://localhost:1338/github/koopjs::geodata::countries::mexico/FeatureServer/0/query

Test

koop-github uses tape for testing.

npm test

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

License

Apache 2.0