https://github.com/Novvum/graphql-birdseye

View any GraphQL schema as a dynamic and interactive graph. 🦅
https://github.com/Novvum/graphql-birdseye

graphql graphql-birdseye graphql-playground graphql-visualizer jointjs

Last synced: about 2 months ago
JSON representation

View any GraphQL schema as a dynamic and interactive graph. 🦅

• Host: GitHub
• URL: https://github.com/Novvum/graphql-birdseye
• Owner: Novvum
• License: mit
• Created: 2018-12-09T04:23:23.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T17:04:56.000Z (about 2 years ago)
• Last Synced: 2024-10-21T00:42:54.438Z (about 2 months ago)
• Topics: graphql, graphql-birdseye, graphql-playground, graphql-visualizer, jointjs
• Language: TypeScript
• Homepage: http://birdseye.novvum.io/
• Size: 13.2 MB
• Stars: 705
• Watchers: 10
• Forks: 21
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome - graphql-birdseye - View any GraphQL schema as a dynamic and interactive graph. 🦅 (TypeScript)
• awesome-list - graphql-birdseye

README

        




View any GraphQL schema as a dynamic and interactive graph.

Try it out now: http://birdseye.novvum.io/






[![NPM](https://img.shields.io/npm/v/graphql-birdseye.svg)](https://www.npmjs.com/package/graphql-birdseye) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

### Description

Birdseye is an interactive tool that dynamically displays GraphQL schemas. It helps teams visualize and understand the nodes and connections within their schema. Birdseye was built using jointJS and makes for a lightweight addition to any web project.

Try the React component on CodeSandbox: 



[![Edit graphql-birdseye-demo](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/xp9mp9rzwo)

### Features

1. Graphical view of any GraphQL schema

2. Ability to click on a field or type to view its connections

3. Dynamic zooming to focus on small portions of the schema at a time

4. Add to any web project

5. Customizable styling and theming

### Getting Started

You can add Birdseye to your project as either a Javascript library or as a React package. Get started by reading the docs for each method:

- [`graphql-birdseye-core` (Javascript library)](./packages/core/README.md)

- [`graphql-birdseye`(React Package)](./packages/react/README.md)

### Background

Birdseye was inspired by [GraphQL Voyager](https://github.com/APIs-guru/graphql-voyager) and the [Apis-guru](https://github.com/APIs-guru) team. We found that Voyager would add 1.2 MB to our projects, which was too big for us. This motivated us to create Birdseye, which has a bundle size of less than 200 KB. Birdseye is open source and free to use and explore.

### Roadmap

We have plans to keep improving Birdseye. Here's what is next:

1. Add Union and Interface type support

1. Improve performance for larger schemas

1. Option to toggle zoom navigation style

1. Smoother UI transitions and interactions

### Contributing

This is an open source project. To learn how to contribute, please check out our [contributing guide](./CONTRIBUTING.md#contributing-guide).

### License

MIT © [Novvum](https://github.com/novvum)

---

Made with ❤️ by Novvum