1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
# graphql <img src="https://cloud.githubusercontent.com/assets/2231765/9094460/cb43861e-3b66-11e5-9fbf-71066ff3ab13.png" height="40" alt="graphql-ruby"/>
[](https://github.com/rmosolgo/graphql-ruby/actions/workflows/ci.yaml)
[](https://rubygems.org/gems/graphql)
A Ruby implementation of [GraphQL](https://graphql.org/).
- [Website](https://graphql-ruby.org/)
- [API Documentation](https://www.rubydoc.info/github/rmosolgo/graphql-ruby)
- [Newsletter](https://buttondown.email/graphql-ruby)
## Installation
Install from RubyGems by adding it to your `Gemfile`, then bundling.
```ruby
# Gemfile
gem 'graphql'
```
```
$ bundle install
```
## Getting Started
```
$ rails generate graphql:install
```
After this, you may need to run `bundle install` again, as by default graphiql-rails is added on installation.
Or, see ["Getting Started"](https://graphql-ruby.org/getting_started.html).
## Upgrade
I also sell [GraphQL::Pro](https://graphql.pro) which provides several features on top of the GraphQL runtime, including:
- [Persisted queries](https://graphql-ruby.org/operation_store/overview)
- [API versioning](https://graphql-ruby.org/changesets/overview)
- [Streaming payloads](https://graphql-ruby.org/defer/overview)
- [Server-side caching](https://graphql-ruby.org/object_cache/overview)
- [Rate limiters](https://graphql-ruby.org/limiters/overview)
- Subscriptions backends for [Pusher](https://graphql-ruby.org/subscriptions/pusher_implementation) and [Ably](https://graphql-ruby.org/subscriptions/ably_implementation)
- Authorization plugins for [Pundit](https://graphql-ruby.org/authorization/pundit_integration) and [CanCan](https://graphql-ruby.org/authorization/can_can_integration)
Besides that, Pro customers get email support and an opportunity to support graphql-ruby's development!
## Goals
- Implement the GraphQL spec & support a Relay front end
- Provide idiomatic, plain-Ruby API with similarities to reference implementation where possible
- Support Ruby on Rails and Relay
## Getting Involved
- __Say hi & ask questions__ in the #graphql-ruby channel on [Discord](https://discord.com/invite/xud7bH9).
- __Report bugs__ by posting a description, full stack trace, and all relevant code in a [GitHub issue](https://github.com/rmosolgo/graphql-ruby/issues).
- __Start hacking__ with the [Development guide](https://graphql-ruby.org/development).
|
