Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/f/graphql.js-demo

GraphQL.js Sinatra Example
https://github.com/f/graphql.js-demo

graphql graphql-server ruby sinatra

Last synced: 18 days ago
JSON representation

GraphQL.js Sinatra Example

Awesome Lists containing this project

README

        

# GraphQL.js Todo App Example

This is a ToDo app example that uses [**GraphQL.js**](https://github.com/f/graphql.js), [**Sinatra**](https://sinatrarb.com) and [**GraphQL-Ruby**](https://github.com/rmosolgo/graphql-ruby).

## Samples

This implementation includes following features:

- Queries
- Mutations
- Subscriptions (Live via EventSource)

![Gif](./demo.gif)

## Installation

```bash
git clone https://github.com/f/graphql.js-demo
cd graphql.js-demo

bundle install
ruby app.rb

# Your server will be started on http://localhost:4567
```

## The Focus

The main focus here to create GraphQL JavaScript clients easily. Please read the following code to see how easy to query a GraphQL server.

```js
var graph = graphql("/graphql", {
alwaysAutodeclare: true,
fragments: {
todo: `on Todo {
id
text
isCompleted
}`
}
})

function getTodos() {
return graph.query.run(`allTodos { ...todo }`)
}

function addTodo(text) {
return graph.mutate(`todoAdd(text: $text) { ...todo }`)({
text: text
})
}

function setTodo(id, isCompleted) {
return graph.mutate(`todoComplete(id: $id, status: $isCompleted) { ...todo }`)({
"id!ID": id,
isCompleted: isCompleted
})
}

function removeTodo(id) {
return graph.mutate(`todoRemove(id: $id) { ...todo }`)({
"id!ID": id
})
}
```

### Subscriptions

This includes `EventSource` model of subscriptions.

```js
var source = new EventSource(`/graphql?query=
subscription ($id: ID!) {
todoAdded(id: $id) {
id
text
}
todoUpdated(id: $id) {
id
isCompleted
}
todoRemoved(id: $id) {
id
}
}`)
source.addEventListener('graphql.todoAdded', function (message) {
var data = JSON.parse(message.data)
var todo = data.data.todoAdded
todos.innerHTML += "

  • " + todo.text + "
  • "
    })
    source.addEventListener('graphql.todoRemoved', function (message) {
    var data = JSON.parse(message.data)
    var todo = data.data.todoRemoved
    var el = document.querySelector("li#" + todo.id)
    todos.removeChild(el)
    })
    source.addEventListener('graphql.todoUpdated', function (message) {
    var data = JSON.parse(message.data)
    var todo = data.data.todoUpdated
    var el = document.querySelector("li#" + todo.id)
    el.className = "completed"
    })
    ```

    ## License

    MIT License

    Copyright (c) 2017 Fatih Kadir Akın

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.