sebas5384/graphql-explorer

GraphQL Explorer

GraphQL Explorer

GraphQL Explorer is an application that helps you define entities related to your business domains, relate them, and then generate GraphQL schemas that can be used to connect different parts of your software, such as client and server.

Demo app

Through the following URL you can find a demo app: https://graphql-explorer.sebas5384.vercel.app/

Pre-requirements

• git
• Node.js LTS version

Cloning the project:

In the terminal of your computer, run git clone https://github.com/sebas5384/graphql-explorer.git.

After cloning the repo, access the directory of it and then follow the installation instructions below.

Installation

Run yarn to install the application dependencies and dev dependencies.

Initializing the local environment

Run yarn start to start the application in dev mode on your own computer.

If everything run as expected, the application should be automatically opened in your default browser in the following address: http://localhost:3000/, and you should see something like this:

How it works

TBD.

Contributing

You can contribute to this project in the following ways:

• Finding and reporting bugs
• Fixing bugs or implementing new features
• Improving the documentation
• Improving the code structure

Steps to contribute

• Fork this repository to your own GitHub account and then clone it to your computer;
• Install the project and dev dependencies (run yarn);
• Make the necessary changes and ensure that the tests are passing using yarn test (implement new tests if needed);
• Send a pull request and I'll be happy to review it 🙌;
• Wait for feedback or approval (this should not take too long).

graphql-explorer's Issues

Add it to the Prisma's GraphQL Playground?

Add SVG/PNG export of the graph

Konva provides PNG export out of the box.

Allow deleting single relation connector

How to delete a node?

HI, thank you for this great tool. I watched the video but I can not figure out how to delete a node :/

Use AST with immutable.js on store

This will be crucial for performance and the export and import feature.

Use graphql codemirror for the editor instead of Slate

https://github.com/graphql/codemirror-graphql

Schema parsing, syntax colors and validation are working already, but not the autocomplete which could be implemented using the built-in feature of the codemirror.

Make changes in types/relation in the schema editor reflect changes in the graph

Refactor React Redux connections to Store from HoCs to Hooks

for example: https://github.com/sebas5384/graphql-explorer/blob/release/alpha/src/modules/editor/containers/ContextualDelete.js#L37

Deploy a preview to Now 2.0

the current link in the README is not working anymore since Vercel (Zeit) deprecate now 1.0

Upgrade all project libraries to their latest version

Allow editing types/relation names in the graph

Add the ability to change color scheme

How to add many to many relationships?

Thank you in advance.

Support multiple relations with the same name

The explorer doesn't know how to draw two different relations with the same field name.

Reproduce:

1. Create type A
2. Create type B
3. Create relation from A to B called foo
4. Create relation from B to A called foo

The result is this:

Add export or copy schema functionality

It would be nice if after creating the business domains it could be possible to copy the generated schemes or to export them as a file so that this information could be used in the applications that will use it.

Update application sample image on README file

The application screenshot used in the README.md file is outdated, and it would be good to use an updated version instead.

Add ability to save or download project file

It would e nice to have a way to save multiple projects in localstorage, and also a way to download them and open/import the downloaded file.