Giter Club home page Giter Club logo

github-graphql-explorer's Introduction

GitHub GraphQL Client tools

## Overview

This simple webserver collection allows the exploration of GitHub GraphQL environemnt, with both a GraphiQL client and GraphQL Voyager.

Setup

The setup is simple. Follow these three steps:

  1. Clone the repo and install dependencies with npm ci
  2. Prepare a .env file which must contain GitHub GraphQL Api endpoint and the token for access
  3. Run the server with npm run serve

.env File

The format of the .env file is the following:

API_URL=
API_TOKEN= 

The API_URL requires the GitHub URL. The public url is https://api.github.com/graphql and a similar format exists for GitHub enterprise. The API_TOKEN is the bearer token for GitHub. To create a GitHub token, please follow the official documentation and give the token all the permissions for the repo scope.

Caveats and limitations

GitHub applies a rate limit policy, so the lack of authentication token would make the suite unsuable. Moreover, because GitHub schema is quite extensive, Voyager can take a bit (up to 120 seconds) to render the entire schema and the final navigation might not the most responsive. Untortunately, this is due to Voyager code.

The upside of this application is that it can works with any GraphQL provider where the following features are available:

  • Introspection enabled
  • Authorization via bearer token

Todo

  • [] Wrap both component into a single page
  • [] Add a webform for collecting the
  • [] Add GraphiQL Explorer to the list of clients

github-graphql-explorer's People

Contributors

lunaticmuch avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.