Skip to content

Instantly share code, notes, and snippets.

@wilhelmklopp
Last active February 10, 2018 19:33
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save wilhelmklopp/96309b04f67d4ac029d1880ca26fc2aa to your computer and use it in GitHub Desktop.
Save wilhelmklopp/96309b04f67d4ac029d1880ca26fc2aa to your computer and use it in GitHub Desktop.
Pre-workshop Instructions for the GitHub GraphQL API workshop
Install Instructions for the MLH Prime GitHub GraphQL API Workshop
1. GraphiQL desktop app (you don't strictly needs this, but it makes tihngs easier)
If you're on a Mac
- If you don't have Brew, install it from here: https://brew.sh/
- if you already have brew run: brew cask install graphiql
If you're on Windows or Linux
- Make sure you have npm installed. (Get node and npm here: https://nodejs.org/en/)
- go to https://github.com/skevy/graphiql-app/releases and download the latest release (Source Code (zip))
- unzip it and cd into the folder
- run npm install
- run npm build
- run npm start
If this doesn't work, you can also use the web version: https://developer.github.com/early-access/graphql/explorer/
Although in my opinion the web version is slightly worse for understanding the whole process because it's more magical.
2. Github API
- If you don't already have a github account, create one: https://github.com
- Join the Early Access programme: https://developer.github.com/early-access/graphql/
3. Get a token
- Go to https://github.com/settings/tokens
- Click "Generate New Token"
- Give your token a name like "Prime API Workshop"
- Select the "repo" and "user" scopes
- Click the green "Generate Token" button
- Keep that token in a safe place for later, we'll need it in the workshop
Open this link in a new tab for later: https://github.com/xoneco/github-graphql-workshop/
GraphQL Documentation (useful for challenges): https://developer.github.com/early-access/graphql/
You made it! 🎉
All good to go for the workshop. :)
@ccannon94
Copy link

@wilhelmklopp it looks like the graphQL API is no longer in the early access program. Is section 2 still relevant?

@techytushar
Copy link

running the build command gives an error, should it be npm run-script build ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment