GraphQL Framework for Javascript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Graphene-JS Build Status PyPI version Coverage Status

Graphene-JS is a JS framework for building GraphQL schemas/types fast and easily.

  • Easy to use: Graphene helps you use GraphQL in Javascript without effort.
  • Relay: Graphene has builtin support for Relay. (on the works)
  • Data agnostic: Graphene supports any kind of data source: SQL (Sequelize), NoSQL, custom objects, etc. We believe that by providing a complete API you could plug Graphene-JS anywhere your data lives and make your data available through GraphQL.

Check also the architecture docs to see how Graphene-JS is architected to ease the development of GraphQL in JS.

Integrations

Graphene has multiple integrations with different frameworks:

integration Package
Sequelize graphene-sequelize
TypeORM on the works

Also, Graphene is fully compatible with the GraphQL spec, working seamlessly with all GraphQL clients, such as Relay, Apollo and urql.

Installation

For instaling graphene, just run this command in your shell

npm install --save graphene-js
# or
yarn add graphene-js

Examples

Here is one example for you to get started:

import { ObjectType, Field, Schema } from "graphene-js";

@ObjectType()
class Query {
  @Field(String)
  hello() {
    return "Hello world!";
  }
}

const schema = new Schema({ query: Query });

Then Querying graphene.Schema is as simple as:

query = `
    query SayHello {
      hello
    }
`;

var result = schema.execute(query);

If you want to learn more, you can also check the documentation or check the provided examples:

Contributing

After cloning this repo, ensure dependencies are installed by running:

yarn

After developing, the full test suite can be evaluated by running:

yarn test

You can also get the coverage with:

yarn test --coverage

Documentation

The documentation is generated using the excellent Sphinx and a custom theme.

The documentation dependencies are installed by running:

cd docs
pip install -r requirements.txt

Then to produce a HTML version of the documentation:

make html