GraphiQL is the reference implementation of this monorepo, GraphQL IDE, an official project under the GraphQL Foundation. The code uses the permissive MIT license.
Whether you want a simple GraphiQL IDE instance for your server, or a more advanced web or desktop GraphQL IDE experience for your framework or plugin, or you want to build an IDE extension or plugin, you've come to the right place!
The purpose of this monorepo is to give the GraphQL Community:
- a solid, to-specification official language service,
- a codemirror mode
- an example of how to use this ecosystem with GraphiQL.
- examples of how to implement or extend GraphiQL
/ˈɡrafək(ə)l/ A graphical interactive in-browser GraphQL IDE. Try the live demo. We also have a demo using our latest netlify build for the master branch.
The GraphiQL IDE, implemented in React, currently using GraphQL mode for CodeMirror & GraphQL Language Service.
(works with create-react-app without requiring additional configuration)
The GraphiQL Readme explains some of the ways to implement GraphiQL, and we also have the examples directory as well!
Provides CodeMirror with a parser mode for GraphQL along with a live linter and typeahead hinter powered by your GraphQL Schema
Provides an interface for building GraphQL language services for IDEs.
Server process backing the GraphQL Language Service.
Runtime agnostic Language Service used by GraphQL mode for CodeMirror and GraphQL Language Service Server
An online immutable parser for GraphQL, designed to be used as part of syntax-highlighting and code intelligence tools such as for the GraphQL Language Service and codemirror-graphql.
Flow and Typescript type definitions for the GraphQL Language Service.
Utilities to support the GraphQL Language Service.
This is an open source project, and we welcome contributions. Please see CONTRIBUTING.md for details on how to contribute.
We welcome contributions and assistance! If you want to know where to start, check out our Github Projects. If you want to add a new feature, note that GraphiQL is eventually going to support its own extension system, and we are rarely adding new features, so make sure you submit feature requests with that in mind.
This repo is a yarn workspaces monorepo that also uses lerna for some convenience.
It requires node 11 and the latest stable version of yarn.
Running these commands with npm will cause you problems.
As of December 2019 we are officially supporting Windows OS for development tooling. If you encounter any bugs when using these or other package.json scripts, please report them!
yarn- install and link all packagesyarn build- cleans first, then builds everything but webpack bundles -tsc --build,babeletcyarn build-bundles- builds webpack bundles that are used for releasesyarn build-demo- builds demo projects for netlify; we run this on CI to make sure webpack can consume our project in a standalone project.yarn test- runs all of the above alongside linting and checks, jest mocha Cypress etc.yarn pretty- autoformatsyarn lint- checks for linting issuesyarn e2e- runs cypress headlessly against the minified bundle and a local schema server, like in CI.yarn jest- runs global jest commands across the entire monorepo; tryyarn jest --watchoryarn jest DocExplorerfor example :D
Learn more in CONTRIBUTING.md documentation.
Lots of activity lately! These things are in progress currently:
- making web and IDE services 100% LSP specification complete
- a monaco editor mode
- extensions and themes to make GraphiQL a multipurpose tool for building GraphQL IDEs
The door is open for proposals for the new GraphiQL Plugin API, and other ideas on how to make the rest of the IDE ecosystem more performant, scaleable, interoperable and extensible.
Feel free to open a PR to create a document in the /proposals/ directory.
Eventually we hope to move these to a repo that serves this purpose.
- Discord - Most discussion outside of github happens on our Discord Server
- Twitter - @GraphiQL and #GraphiQL
- GitHub - Create feature requests and start discussions above