Skip to content
This repository was archived by the owner on Dec 23, 2017. It is now read-only.

Commit ce76264

Browse files
committed
chore: customize base repo settings
1 parent 8d543dd commit ce76264

File tree

3 files changed

+11
-35
lines changed

3 files changed

+11
-35
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ branches:
2626
- /^greenkeeper/.*$/
2727
env:
2828
global:
29-
- CC_TEST_REPORTER_ID=3f97d4ca639289c139796067359d46e7583e2d83701a315e40c1d1f58567afa8
29+
- CC_TEST_REPORTER_ID=498901dee0a2d339971e1bef0d73e3564e5362b33ad765b53cd6fd2e92529ac6

README.md

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,24 @@
11
<img src="https://gramps-graphql.github.io/gramps-express/assets/img/gramps-banner.png" alt="GrAMPS · An easier way to manage the data sources powering your GraphQL server" width="450">
22

3-
# GrAMPS GraphQL Data Source Base
4-
[![Build Status](https://travis-ci.org/gramps-graphql/data-source-base.svg?branch=master)](https://travis-ci.org/gramps-graphql/data-source-base) [![Maintainability](https://api.codeclimate.com/v1/badges/ac264833fac1fbd1afe0/maintainability)](https://codeclimate.com/github/gramps-graphql/data-source-base/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/ac264833fac1fbd1afe0/test_coverage)](https://codeclimate.com/github/gramps-graphql/data-source-base/test_coverage) [![npm version](https://img.shields.io/npm/v/@gramps/data-source-base.svg?style=flat)](https://www.npmjs.com/package/@gramps/data-source-base) [![Greenkeeper badge](https://badges.greenkeeper.io/gramps-graphql/data-source-base.svg)](https://greenkeeper.io/)
3+
# GrAMPS GraphQL Data Source for the [IMDB API](http://www.theimdbapi.org/)
4+
[![Build Status](https://travis-ci.org/gramps-graphql/data-source-imdbapi.svg?branch=master)](https://travis-ci.org/gramps-graphql/data-source-imdbapi) [![Maintainability](https://api.codeclimate.com/v1/badges/ac264833fac1fbd1afe0/maintainability)](https://codeclimate.com/github/gramps-graphql/data-source-imdbapi/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/ac264833fac1fbd1afe0/test_coverage)](https://codeclimate.com/github/gramps-graphql/data-source-imdbapi/test_coverage) [![npm version](https://img.shields.io/npm/v/@gramps/data-source-imdbapi.svg?style=flat)](https://www.npmjs.com/package/@gramps/data-source-imdbapi) [![Greenkeeper badge](https://badges.greenkeeper.io/gramps-graphql/data-source-imdbapi.svg)](https://greenkeeper.io/)
55

6-
This is a minimal example and boilerplate for a GrAMPS data source. Inside, you’ll find:
6+
Look up trailers, ratings, and other information about movies from the [IMDB API](http://www.theimdbapi.org/).
77

8-
- **Connector** — how to access the data source (e.g. a REST API)
9-
- **Model** — methods to retrieve/modify data from the data source (e.g. a
10-
CRUD wrapper)
11-
- **Schema** — description for GraphQL to interpret the data (see the
12-
[GraphQL docs on schemas](http://graphql.org/learn/schema/))
13-
- **Resolvers** — functions to map the results of calls to model methods to
14-
the schema
8+
## Example Queries
159

16-
Each file contains a `TODO` comment explaining the changes you’ll need to make to create a working data source.
17-
18-
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.
19-
20-
## Code Quality and Continuous Integration
21-
22-
To help ensure a reliable, easy-to-maintain data source, this example also includes:
23-
24-
- Configuration for Travis CI (for automated testing) and Code Climate
25-
(for quality analysis)
26-
- Starts you off right with test coverage at 💯
27-
- Provides testing helpers for common resolver testing patterns
28-
- Comes with docs! https://ibm.biz/graphql-data-source
10+
TKTK
2911

3012
## Quickstart
3113

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

3416
```sh
3517
# Clone the repo
36-
git clone [email protected]:gramps-graphql/data-source-base.git data-source-YOUR_DATA_SOURCE_NAME
18+
git clone [email protected]:gramps-graphql/data-source-imdbapi.git data-source-YOUR_DATA_SOURCE_NAME
3719

3820
# Move into it
39-
cd data-source-YOUR_DATA_SOURCE_NAME/
40-
41-
# Change the remote repo
42-
git remote set-url origin [email protected]:USER_OR_ORG/YOUR_REPO_NAME.git
43-
44-
# IMPORTANT: Make sure to edit the name, description, contributors, and
45-
# repository fields in package.json
21+
cd data-source-imdbapi/
4622

4723
# Install dependencies
4824
yarn install

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2-
"name": "@gramps/data-source-base",
3-
"description": "Base modules for a GrAMPS GraphQL data source.",
2+
"name": "@gramps/data-source-imdbapi",
3+
"description": "GrAMPS GraphQL data source for the IMDB API.",
44
"contributors": [
55
"Jason Lengstorf <[email protected]>"
66
],
77
"repository": {
88
"type": "git",
9-
"url": "https://github.com/gramps-graphql/data-source-base.git"
9+
"url": "https://github.com/gramps-graphql/data-source-imdbapi.git"
1010
},
1111
"main": "dist/index.js",
1212
"directories": {

0 commit comments

Comments
 (0)