Skip to content

README.md

Latest commit

 

History

History
41 lines (30 loc) · 1.37 KB

README.md

File metadata and controls

41 lines (30 loc) · 1.37 KB

ElasticGraph::GraphiQL

Provides a GraphiQL IDE for ElasticGraph projects.

Dependency Diagram

graph LR;
    classDef targetGemStyle fill:#FADBD8,stroke:#EC7063,color:#000,stroke-width:2px;
    classDef otherEgGemStyle fill:#A9DFBF,stroke:#2ECC71,color:#000;
    classDef externalGemStyle fill:#E0EFFF,stroke:#70A1D7,color:#2980B9;
    elasticgraph-graphiql["elasticgraph-graphiql"];
    class elasticgraph-graphiql targetGemStyle;
    elasticgraph-rack["elasticgraph-rack"];
    elasticgraph-graphiql --> elasticgraph-rack;
    class elasticgraph-rack otherEgGemStyle;
    elasticgraph-local["elasticgraph-local"];
    elasticgraph-local --> elasticgraph-graphiql;
    class elasticgraph-local otherEgGemStyle;
Loading

Usage

Use this gem with any rack-compatible server. Here's an example config.ru:

require 'elastic_graph/graphql'
require 'elastic_graph/graphiql'

graphql = ElasticGraph::GraphQL.from_yaml_file("config/settings/local.yaml")
run ElasticGraph::GraphiQL.new(graphql)

Run this with rackup (after installing the rackup gem) or any other rack-compatible server.

License

elasticgraph-graphiql is released under the MIT License.

Part of the distributed code comes from the GraphiQL project, also licensed under the MIT License, Copyright (c) GraphQL Contributors.