Get a ready-to-use GraphQL API for your schema
Switch branches/tags
Nothing to show
Clone or download
schickling Merge pull request #17 from bobagold/fix-readme-model
update README to be in sync with graphcool/framework
Latest commit d0fde73 Jan 5, 2018
Permalink
Failed to load latest commit information.
examples schema -> graphql Jun 9, 2017
resources resources Mar 14, 2017
src display Subscription API Sep 25, 2017
.gitignore examples Mar 14, 2017
README.md update README to be in sync with graphcool/framework Jan 5, 2018
package.json 1.1.1 Sep 25, 2017
tsconfig.json init Mar 11, 2017
yarn.lock deps Mar 11, 2017

README.md

graphql-up

graphql-up is the fastest way to get a free & ready to use GraphQL API. It works out of the box with Apollo & Relay and supports GraphQL subscriptions.

Features

  • πŸš€ Get a instant GraphQL API for your schema
  • βš›οΈ Optimized endpoints for Apollo & Relay
  • πŸ‘¨β€πŸ« Easy to add to your own tutorials, docs & examples

Quickstart

type Tweet @model {
  id: ID! @isUnique
  text: String!
  author: User! @relation(name: "Tweets")
}

type User @model {
  id: ID! @isUnique
  name: String!
  tweets: [Tweet!]! @relation(name: "Tweets")
}

Copy the schema above and save it as twitter.graphql. (Read more about the IDL syntax.)

# Install the CLI via npm (or yarn)
npm install -g graphql-up

# Create GraphQL API using your local schema file
graphql-up twitter.graphql

This is how it should look like (see this video tutorial for more details):

Usage

  Usage: graphql-up <schema>
  
    Get a ready-to-use GraphQL API for your schema
    Read more at https://www.graph.cool/graphql-up/
    
  Examples:
    graphql-up twitter.graphql                          # local schema file
    graphql-up https://graphqlbin.com/twitter.graphql   # fetch schema from URL
    
    More examples: https://github.com/graphcool/graphql-up

  Options:
    --version, -v   Print version of graphql-up
    --help, -h      Show help message
    --minimal, -m   Only print URLs of created API

Local schema file

graphql-up twitter.graphql

Hosted schema file

graphql-up https://graphqlbin.com/twitter.graphql

How it works

You only need to provide the schema, graphql-up will create a GraphQL API for you. The actual magic happens on the servers sponsored by Graphcool.

Add graphql-up to your repositories/docs

You can easily add a graphql-up badge to your own tutorials, docs & examples. Just add the following Markdown snippet and replace the __SCHEMA_URL__ with a link to your schema file. (See here for a snippet generator.)

[![graphql-up](http://static.graph.cool/images/graphql-up.svg)](https://www.graph.cool/graphql-up/new?source=__SCHEMA_URL__)

Schema Examples

Do you have another interesting example in mind? Add it here. πŸ“š

Help & Community Slack Status

Join our Slack community if you run into issues or have questions. We love talking to you!