ashfurrow / metaphysics

Artsy's GraphQL API

Metaphysics is a GraphQL-compliant API that wraps various Artsy APIs. You can try it here against our staging API.

It is built on express, express-graphql, and graphql. With graphiql providing a sandbox to work with.

It is currently used in production all over the place in Artsy.net, and the Artsy iOS App

Meta

• State: production
• Production: metaphysics-production.artsy.net
• Staging: metaphysics-staging.artsy.net
• CI: Semaphore
• Point People: @alloy & @mzikherman

Getting Setup

Set up your .env file based on our example .env.test (the variables you must change for development are separated at the bottom).

Install memcached and Yarn if you don't already have them:

brew install memcached
npm install -g yarn

To start up a development server, clone this repo and run:

yarn install
npm run dev

If you are using VS Code, you can read debugging with VS Code to get inline debugging.

Setting up your local GraphiQL

You will need to set up headers with both:

• x-access-token - Get your clientID and secret, use this command to generate a token.
• x-user-id - Go to the users admin and find your user account ID.

If you need to generate a token, this command will create one for you. Add it to your .bash_rc.private and update the values between < and >.

alias generate-access-token='curl "https://stagingapi.artsy.net/oauth2/access_token?client_id=><client id>&client_secret=<client secret>&grant_type=credentials&email=<your email>&password=<your password>&scope=offline_access"'

Testing

npm test to run the entire suite npm run watch to spin up the test watcher

Deployment

PRs merged to master are deployed to staging via Semaphore.

We then use the heroku pipelines to deploy to production when happy with staging.

Add the staging instance as a git remote named staging:

git remote add staging [e-mail]:artsy-metaphysics-staging.git

Then promote using the command:

$ heroku pipelines:promote -r staging