@gramps/data-source-base

GrAMPS GraphQL Data Source Base

This is a minimal example and boilerplate for a GrAMPS data source. Inside, you’ll find:

• Context — an object with methods to retrieve/modify data from the data source (e.g. a CRUD wrapper)
• Schema — type definitions for GraphQL to interpret the data (see the GraphQL docs on schemas)
• Resolvers — functions to map the results of calls to model methods to the schema
• Mock Resolvers — mock functions for offline development

Each file contains a TODO comment explaining the changes you’ll need to make to create a working data source.

The goal of this repo is to provide enough code to allow a working example of a data source and its related tests, but to limit how much boilerplate needs to be edited to get your own data source implemented.

Code Quality and Continuous Integration

To help ensure a reliable, easy-to-maintain data source, this example also includes:

• Configuration for Travis CI (for automated testing) and Code Climate (for quality analysis)
• Starts you off right with test coverage at 💯
• Provides testing helpers for common resolver testing patterns
• Comes with docs! https://ibm.biz/graphql-data-source

Quickstart

NOTE: Replace all instances of YOUR_DATA_SOURCE_NAME with the actual name you want to use (e.g. data-source-companyname-datatype).

# Get a copy of the data source
npx degit gramps-graphql/data-source-base data-source-YOUR_DATA_SOURCE_NAME

# Move into it
cd data-source-YOUR_DATA_SOURCE_NAME/

# IMPORTANT: Make sure to edit the name, description, contributors, and 
# repository fields in package.json

# Install dependencies
yarn

# Start the dev server
yarn dev

You'll see a message with URLs for the GraphQL gateway and the GraphQL Playground. Open the Playground link (usually http://localhost:8080/playground if you don’t already have something running on port 8080), then run a query:

{
  getById(id: 123) {
    id
    name
    lucky_numbers
  }
}

To Develop with Mock Data

Start the app with the following command:

# Start the gateway with mock data
yarn dev --mock

Notes for Developers

Currently, there is no watch capability (PRs welcome!), so the service needs to be stopped (control + C) and restarted (yarn dev) to reflect new changes to the data source.