# orpheus-gql

> ## Download ``` npm i orpheus-gql ```

Latest version **1.0.8** (published 2019-04-19) · 0 weekly downloads

## Install

```sh
npm install orpheus-gql
pnpm add orpheus-gql
yarn add orpheus-gql
bun add orpheus-gql
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2019-04-19 |
| First published | 2019-04-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 494.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | teamaxolotl |

## Links

- npm: https://www.npmjs.com/package/orpheus-gql
- npm.io page: https://npm.io/package/orpheus-gql

## Recent versions

- 1.0.8 (latest) — 2019-04-19
- 1.0.7 — 2019-04-19
- 1.0.6 — 2019-04-17
- 1.0.5 — 2019-04-17

## README

# Orpheus GQL

## Download
```
npm i orpheus-gql
```

## Installation

1. Import OrpheusGQL into your app
2. Configure Orpheus with your endpoint URL
3. Navigate to '/orpheus' to use the GUI

``` javascript
const orpheus = require('orpheus-gql');
const orph = orpheus.config('http://localhost:[your-port]/[graphql endpoint]');

app.use('/graphql', graphqlHTTP(request=>{
    return {
        schema,
        context: orpheus.context(),
        graphiql: true,
        extensions: orpheus.extension
    }
}))

app.get('/orpheus', orph)
```
## Usage

1. Enter your JavaScript GraphQL query in the code editor on the left
![](orph-gif/query.gif)

2. Click Run

3. Results will be displayed visually on the graph; scalar values can be viewed below the graph

4. Center of the graph represents entry point into your database

5. Queries that return multiple items will be represented numerically

6. Labels will be given to each resolver of the item

7. History button will reveal archived queries 
displayed in descending order (with the most recent query at the top position)
![](orph-gif/history.gif)

8. Clicking on a previous query will populate the code editor for it to be executed
![](orph-gif/historyquery.gif)

---
_Source: https://npm.io/package/orpheus-gql · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._