Skip to content

Commit

Permalink
📝 Updated readme according to new version
Browse files Browse the repository at this point in the history
  • Loading branch information
aexol committed Aug 11, 2021
1 parent 1b13467 commit b2d09b8
Show file tree
Hide file tree
Showing 54 changed files with 403 additions and 33,107 deletions.
40 changes: 2 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,40 +16,20 @@ Here is a [guide](https://guide.graphqleditor.com) for GraphQL Editor.

Create GraphQL nodes and connect them to generate a database schema. You can also use builtin text IDE with GraphQL syntax validation

### GraphQL View

![GraphQLEditor Editor](assets/browse-graf.gif)

### Code Editor View

![GraphQLEditor Editor](assets/browse-code.gif)

### Hierarchy View

![GraphQLEditor Editor](assets/browse-diagram.gif)
![demo](assets/demo.gif)

## Table of contents

- [Docs](#docs)
- [How it works](#how-it-works)
- [GraphQL View](#graphql-view)
- [Code Editor View](#code-editor-view)
- [Hierarchy View](#hierarchy-view)
- [Table of contents](#table-of-contents)
- [Developer Docs](#developer-docs)
- [License](#license)
- [Develop or use standalone](#develop-or-use-standalone)
- [Support](#support)
- [Contribute](#contribute)
- [Team](#team)
- [Underlying Diagram technology](#underlying-diagram-technology)
- [Underlying Parsing technology](#underlying-parsing-technology)
- [GraphQL Tutorials](#graphql-tutorials)

## Developer Docs

If you wish to contribute docs from `typedoc` are availble on [https://graphql-editor.github.io/graphql-editor/](https://graphql-editor.github.io/graphql-editor/)

## License

MIT
Expand All @@ -65,7 +45,7 @@ npm i react react-dom monaco-editor
```

```
npm i -D monaco-editor-webpack-plugin worker-loader css-loader file-loader
npm i -D worker-loader css-loader file-loader
```

```
Expand Down Expand Up @@ -123,24 +103,10 @@ render(<App />, document.getElementById('root'));

[Join our Discord Channel](https://discord.gg/wVcZdmd)

## Contribute

For a complete guide to contributing to GraphQL Editor, see the [Contribution Guide](CONTRIBUTING.md).

1. Fork this repo
2. Create your feature branch: git checkout -b feature-name
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request

## Team

[GraphQL Editor Website](https://graphqleditor.com)

## Underlying Diagram technology

Whole graphql-editor is based on underlying [diagram](https://github.com/graphql-editor/diagram) technology.

## Underlying Parsing technology

Whole graphql-editor parsing stuff is based on underlying [zeus](https://github.com/graphql-editor/graphql-zeus) technology.
Expand All @@ -152,5 +118,3 @@ Interactive GraphQL Tutorial [here](https://app.graphqleditor.com/?step=intro)
GraphQL Editor Guide [here](https://guide.graphqleditor.com/)

GraphQL Blog [here](https://blog.graphqleditor.com/)

My Video Blog Tutorials [here](https://stackofthefuture.com)
Binary file added assets/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/assets/css/main.css

This file was deleted.

Binary file removed docs/assets/images/icons.png
Binary file not shown.
Binary file removed docs/assets/images/[email protected]
Binary file not shown.
Binary file removed docs/assets/images/widgets.png
Binary file not shown.
Binary file removed docs/assets/images/[email protected]
Binary file not shown.
51 changes: 0 additions & 51 deletions docs/assets/js/main.js

This file was deleted.

1 change: 0 additions & 1 deletion docs/assets/js/search.json

This file was deleted.

334 changes: 0 additions & 334 deletions docs/classes/dom.html

This file was deleted.

495 changes: 0 additions & 495 deletions docs/classes/treetonodes.html

This file was deleted.

183 changes: 0 additions & 183 deletions docs/classes/workers.html

This file was deleted.

201 changes: 0 additions & 201 deletions docs/enums/keyboardactions.html

This file was deleted.

201 changes: 0 additions & 201 deletions docs/enums/statusdotprops.html

This file was deleted.

8,215 changes: 0 additions & 8,215 deletions docs/globals.html

This file was deleted.

8,216 changes: 0 additions & 8,216 deletions docs/index.html

This file was deleted.

181 changes: 0 additions & 181 deletions docs/interfaces/box.html

This file was deleted.

181 changes: 0 additions & 181 deletions docs/interfaces/codepaneouterprops.html

This file was deleted.

209 changes: 0 additions & 209 deletions docs/interfaces/editabledefaultvalueprops.html

This file was deleted.

223 changes: 0 additions & 223 deletions docs/interfaces/editorerror.html

This file was deleted.

257 changes: 0 additions & 257 deletions docs/interfaces/editorprops.html

This file was deleted.

182 changes: 0 additions & 182 deletions docs/interfaces/extendnodemenuprops.html

This file was deleted.

224 changes: 0 additions & 224 deletions docs/interfaces/fieldportprops.html

This file was deleted.

399 changes: 0 additions & 399 deletions docs/interfaces/fieldprops.html

This file was deleted.

136 changes: 0 additions & 136 deletions docs/interfaces/grafprops.html

This file was deleted.

167 changes: 0 additions & 167 deletions docs/interfaces/iconprops.html

This file was deleted.

181 changes: 0 additions & 181 deletions docs/interfaces/indexedboxes.html

This file was deleted.

181 changes: 0 additions & 181 deletions docs/interfaces/indexeddimensions.html

This file was deleted.

181 changes: 0 additions & 181 deletions docs/interfaces/layout.html

This file was deleted.

197 changes: 0 additions & 197 deletions docs/interfaces/menuitemprops.html

This file was deleted.

4,470 changes: 0 additions & 4,470 deletions docs/interfaces/menuprops.html

This file was deleted.

231 changes: 0 additions & 231 deletions docs/interfaces/menusearchprops.html

This file was deleted.

202 changes: 0 additions & 202 deletions docs/interfaces/newnodeprops.html

This file was deleted.

196 changes: 0 additions & 196 deletions docs/interfaces/nodeadddirectivemenuprops.html

This file was deleted.

196 changes: 0 additions & 196 deletions docs/interfaces/nodeaddfieldmenuprops.html

This file was deleted.

196 changes: 0 additions & 196 deletions docs/interfaces/nodedirectiveoptionsmenuprops.html

This file was deleted.

196 changes: 0 additions & 196 deletions docs/interfaces/nodeimplementinterfacesmenuprops.html

This file was deleted.

196 changes: 0 additions & 196 deletions docs/interfaces/nodeinterfaceprops.html

This file was deleted.

267 changes: 0 additions & 267 deletions docs/interfaces/nodeprops.html

This file was deleted.

196 changes: 0 additions & 196 deletions docs/interfaces/nodetypeoptionsmenuprops.html

This file was deleted.

4,470 changes: 0 additions & 4,470 deletions docs/interfaces/optionsmenuprops.html

This file was deleted.

195 changes: 0 additions & 195 deletions docs/interfaces/paintfieldprops.html

This file was deleted.

181 changes: 0 additions & 181 deletions docs/interfaces/passedschema.html

This file was deleted.

197 changes: 0 additions & 197 deletions docs/interfaces/placefunctionargs.html

This file was deleted.

181 changes: 0 additions & 181 deletions docs/interfaces/rootextendnodeprops.html

This file was deleted.

181 changes: 0 additions & 181 deletions docs/interfaces/rootnodeprops.html

This file was deleted.

181 changes: 0 additions & 181 deletions docs/interfaces/themedefinition.html

This file was deleted.

172 changes: 0 additions & 172 deletions docs/interfaces/theming.html

This file was deleted.

167 changes: 0 additions & 167 deletions docs/interfaces/titleofpaneprops.html

This file was deleted.

1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
"domTree": "tree src/domStructure/domStructure.treelang -f ts > src/domStructure/domStructure.ts",
"test": "jest",
"e2e:test": "cypress open",
"docs": "typedoc --mode file --out docs --theme minimal --ignoreCompilerErrors --target ES6 ",
"updatedeps": "npm i graphql-zeus@latest graphsource@latest",
"lint": "eslint \"./src/**/*.{ts,js}\" --quiet --fix && prettier --write \"./src/**/*.{ts,js}\" "
},
Expand Down
33 changes: 33 additions & 0 deletions sandbox/apps/googlediff.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import React from 'react';
import { GraphQLEditor } from '@/index';
import { DarkTheme } from '@/Theming/DarkTheme';
import * as schemas from '../schema';

export const googlediff = () => {
return (
<div
style={{
flex: 1,
width: '100%',
height: '100%',
alignSelf: 'stretch',
display: 'flex',
position: 'relative',
}}
>
<GraphQLEditor
theme={DarkTheme}
schema={{ code: schemas.googleDirectionsNew }}
setSchema={() => {}}
diffSchemas={{
newSchema: {
code: schemas.googleDirectionsNew,
},
oldSchema: {
code: schemas.googleDirectionsOld,
},
}}
/>
</div>
);
};
1 change: 1 addition & 0 deletions sandbox/apps/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ export * from './Pure';
export * from './SetSchema';
export * from './withSchema';
export * from './diff';
export * from './googlediff';
export * from './libraries';
export * from './readonly';
Loading

0 comments on commit b2d09b8

Please sign in to comment.