Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Brbb/graphql-rover
:rocket: GraphQL + Vue.js + D3.js schema viewer, powered by introspection.
https://github.com/Brbb/graphql-rover
d3js dagre graphql introspection schema viewer vuejs
Last synced: about 1 month ago
JSON representation
:rocket: GraphQL + Vue.js + D3.js schema viewer, powered by introspection.
- Host: GitHub
- URL: https://github.com/Brbb/graphql-rover
- Owner: Brbb
- License: mit
- Created: 2017-08-07T03:53:38.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-09-25T12:07:18.000Z (about 1 year ago)
- Last Synced: 2024-04-29T18:11:24.762Z (8 months ago)
- Topics: d3js, dagre, graphql, introspection, schema, viewer, vuejs
- Language: JavaScript
- Homepage:
- Size: 502 KB
- Stars: 264
- Watchers: 16
- Forks: 23
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-graphql - GraphQL Rover - GraphQL schema interactive navigation, rearrange nodes, search and explore types and fields. (Tools / Julia Libraries)
- awesome-graphql-security - GraphQL Rover - GraphQL schema viewer for endpoints with introspection (Neutral Security / Visualizers)
README
# GraphQL Rover
## Intro
**GraphQL Rover** is a [GraphQL](http://graphql.org/) schema viewer.
Generate a navigable representation of the underlying schema through the [introspection](http://graphql.org/learn/introspection/) query, displaying nodes as [Vue.js](https://vuejs.org/) components using [D3.js](https://d3js.org/) to build the graph.
Check the [Demo](https://brbb.github.io/graphql-rover/) based on the _GraphQL Pokemon API_, allow `HTTP` scripts execution or change the endpoint from the side panel.
## Quick start
1. Setup the endpoint
2. Re-arrange nodes
3. Select to zoom and inspect a type or use the search bar
## Run
#### Option 1:
`git clone` the [repo](https://github.com/Brbb/graphql-rover.git) anywhere, run locally `path-to-graphql-rover/graphql-rover/index.html` and follow the quickstart steps. There's no need to keep Rover in the same path of your database, or on a server.
#### Option 2:
Run as Electron app and follow the quickstart steps:
``` shell
$ cd graphql-rover/
$ electron .
```
#### Option 3
Run the GraphQL Rover.app (OSX electron package only)
## Features
- [x] Endpoint selection and configuration
- [ ] Save configuration (locally/remotely)
- [x] Drag nodes
- [x] Pan & Zoom
- [x] Zoom on selection
- [x] Navigate clicking on Type-links inside the node or the documentation panel
- [x] Type Documentation
- [x] Type & field search
- [x] Type & field filter for a cleaner graph
- [x] Interface / Enumerable / Types easy identification
- [x] Relationships edges with UML-like semantic
- [x] Configure GraphQL endpoint
- [x] No code to write (but a module/library could be interesting)
- [ ] Offline schema (paste introspection result + libraries included)
- [ ] Electron app
## Tech Stack
Rover is built with pure javascript libraries to avoid mixed or _language_-to-javascript solutions:
- [GraphQL](http://graphql.org/): the introspection query is actually what is really used by Rover to get the schema topology. On further releases it could be possible to query the data of the selected type.
- [Dagre-d3](https://github.com/cpettitt/dagre-d3): basically the core of the graph schema building system, replaces graphviz and offers a pure javascript alternative.
- [Vue.js](https://vuejs.org/) + [Vuex](https://vuex.vuejs.org/en/intro.html) + [Element](http://element.eleme.io/#/): D3 nodes require a html label, and Vue can easily provide a template adaptable to any type retrieved. Vuex stores data and manages the state while Element provides a pleasant UI library.
## Electron
An OS X electron app exists, but currently it's not complete. The bundle will be released as soon as possible with a Windows and Linux package.
## To-Dos
- [ ] Single edge with double arrowhead to limit the number of lines and improve readability
- [ ] NPM module
- [x] Live Demo
- [ ] Test Test Test Test
- [ ] CI