-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
26 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,37 @@ | ||
# Symfony2 GraphQl Bundle | ||
# Symfony GraphQl Bundle | ||
|
||
### True object oriented GraphQL PHP Server realization | ||
### This is a bundle based on the pure [GraphQL PHP Server implementation](http://github.com/youshido/graphql/) | ||
|
||
This is not a PHP port of the JavaScript GraphQL. | ||
This is a Object oriented realization of the GraphQL server conforming the [RFC Specification for GraphQL](https://facebook.github.io/graphql/). | ||
This bundle provides you with: | ||
|
||
* Full compatibility with the [RFC Specification for GraphQL](https://facebook.github.io/graphql/) | ||
* Agile object oriented structure to architect your GraphQL Schema | ||
* Intuitive Type system that allows you to build your project much faster and stay consistent | ||
* Build-in validation for the GraphQL Schema you develop | ||
* Well documented classes with a lot of examples | ||
* Automatically created endpoint /graphql to handle requests | ||
|
||
## Installing graphql-bundle | ||
## Installing GraphQL Bundle | ||
|
||
We assume you have `composer`, if not – [go get install Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx). | ||
After that, simply run | ||
We assume you have `composer`, but if you're not – install it from the [official website](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx). | ||
After you've done with that, simply run | ||
``` | ||
$> composer require youshido/graphql-bundle='dev-master' | ||
$> composer require youshido/graphql-bundle | ||
``` | ||
|
||
Than add bundle to your `app/AppKernel.php` | ||
``` | ||
... | ||
new Youshido\GraphQLBundle\GraphQLBundle(), | ||
... | ||
``` | ||
|
||
And finally adding routing reference to the `app/config/routing.yml`: | ||
And finally add the routing reference to the `app/config/routing.yml`: | ||
``` | ||
graphql: | ||
resource: "@GraphQLBundle/Controller/" | ||
``` | ||
|
||
## Examples | ||
## Documentation | ||
|
||
Right now you can learn some examples in our test directory but we're going to put out the whole step by step guide for you soon. | ||
Detailed documentation is available on the main GraphQL repository – http://github.com/youshido/graphql/. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,18 @@ | ||
{ | ||
"name": "youshido/graphql-bundle", | ||
"description": "Symfony2 GraphQl Bundle", | ||
"description": "Symfony GraphQl Bundle", | ||
"minimum-stability": "stable", | ||
"license": "proprietary", | ||
"authors": [ | ||
{ | ||
"name": "Portey Vasil", | ||
"email": "[email protected]" | ||
}, | ||
{ | ||
"name": "Alexandr Viniychuk", | ||
"email": "[email protected]" | ||
} | ||
|
||
], | ||
"autoload": { | ||
"psr-4": { | ||
|
@@ -16,9 +21,9 @@ | |
}, | ||
"require": { | ||
"php": ">=5.5", | ||
"youshido/graphql": "~0.0.2" | ||
"youshido/graphql": "~1.0.1" | ||
}, | ||
"require-dev": { | ||
"phpunit/phpunit": "~4.7" | ||
} | ||
} | ||
} |