fandogh/laravel-graphql-relay

Adds relay specifications to laravel graphql server

0.4.0 2016-07-27 10:07 UTC

Requires

• doctrine/dbal: 2.5.*
• illuminate/console: 5.*
• webonyx/graphql-php: 0.6.*

Requires (Dev)

• orchestra/testbench: ~3.0
• phpunit/phpunit: 4.*

MIT

• Christopher Moore
• Pooya Parsa

• laravel
• react
• graphql
• Relay

README

an active fork of nuwave/laravel-graphql-relay

Use Facebook GraphQL with React Relay. This package extends graphql-php to work with Laravel and is currently a work in progress. You can reference what specifications GraphQL needs to provide to work with Relay in the documentation.

Although this package no longer depends on laravel-graphql, it laid the foundation for this package which likely wouldn't exist without it. It is also a great alternative if you are using GraphQL w/o support for Relay.

Because this package is still in the early stages, breaking changes will occur. We will keep the documentation updated with the current release. Please feel free to contribute, PR are absolutely welcome!

Installation

You must then modify your composer.json file and run composer update to include the latest version of the package in your project.

"require": {
    "fandogh/laravel-graphql-relay": "0.3.*"
}

Or you can use the composer require command from your terminal.

composer require fandogh/laravel-graphql-relay

Add the service provider to your config/app.php file

Nuwave\Relay\LaravelServiceProvider::class

Add the Relay & GraphQL facade to your app/config.php file

'GraphQL' => Nuwave\Relay\Facades\GraphQL::class,
'Relay' => Nuwave\Relay\Facades\Relay::class,

Publish the configuration file

php artisan vendor:publish --provider="Nuwave\Relay\LaravelServiceProvider"

Create a schema.php file and add the path to the config. See the Schema wiki page for more information on schema.php.

// config/relay.php
// ...
'schema' => [
    'path'      => 'Http/schema.php',
    'output'    => null,
],

To generate a schema.json file (used with the Babel Relay Plugin):

php artisan relay:schema

You can customize the output path in the relay.php config file under schema.output

For additional documentation, look through the docs folder or read the Wiki.