GraphQLEditor makes it easier to understand GraphQL schemas. Create a schema by using visual blocks system. GraphQL Editor will transform them into code. With GraphQL Editor you can create visual diagrams without writing any code or present your schema in a nice way!
Cloud version
Here is a cloud version of GraphQL Editor.
Docs
Here is a guide for GraphQL Editor.
How it works
Create GraphQL nodes and connect them to generate a database schema. You can also use builtin text IDE with GraphQL syntax validation
GraphQL View
Code Editor View
Hierarchy View
Table of contents
- Docs
- How it works
- Table of contents
- Developer Docs
- License
- Develop or use standalone
- Support
- Contribute
- Team
- Underlying Diagram technology
- Underlying Parsing technology
- GraphQL Tutorials
Developer Docs
If you wish to contribute docs from typedoc
are availble on https://graphql-editor.github.io/graphql-editor/
License
MIT
Develop or use standalone
To use standalone you have to use webpack right now. If you want to use it without webpack you need to handle monaco editor workers yourself.
Install dependencies
npm i react react-dom monaco-editor
npm i -D monaco-editor-webpack-plugin worker-loader css-loader file-loader
npm i graphql-editor
import React, { useState } from 'react';
import { render } from 'react-dom';
import { GraphQLEditor,PassedSchema } from 'graphql-editor';
const schemas = {
pizza:`
type Query{
pizzas: [Pizza!]
}
`,
pizzaLibrary:`
type Pizza{
name:String;
}
`
}
export const App = () => {
const [mySchema, setMySchema] = useState<PassedSchema>({
code: schemas.pizza,
libraries: schemas.pizzaLibrary,
});
return (
<div
style={{
flex: 1,
width: '100%',
height: '100%',
alignSelf: 'stretch',
display: 'flex',
position: 'relative',
}}
>
<GraphQLEditor
onSchemaChange={(props) => {
setMySchema(props);
}}
schema={mySchema}
/>
</div>
);
};
render(<App />, document.getElementById('root'));
Support
Contribute
For a complete guide to contributing to GraphQL Editor, see the Contribution Guide.
- Fork this repo
- Create your feature branch: git checkout -b feature-name
- Commit your changes: git commit -am 'Add some feature'
- Push to the branch: git push origin my-new-feature
- Submit a pull request
Team
Underlying Diagram technology
Whole graphql-editor is based on underlying diagram technology.
Underlying Parsing technology
Whole graphql-editor parsing stuff is based on underlying zeus technology.
GraphQL Tutorials
GraphQL Editor Guide here
GraphQL Blog here
My Video Blog Tutorials here