Repository files navigation

https://the-guild.dev/graphql/codegen

GraphQL Code Generator is a tool that generates code out of your GraphQL schema. Whether you are developing a frontend or backend, you can utilize GraphQL Code Generator to generate output from your GraphQL Schema and GraphQL Documents (query/mutation/subscription/fragment).

By analyzing the schema and documents and parsing it, GraphQL Code Generator can output code at a wide variety of formats, based on pre-defined templates or based on custom user-defined ones. Regardless of the language that you're using, GraphQL Code Generator has you covered.

GraphQL Code Generator lets you choose the output that you need, based onplugins, which are very flexible and customizable. You can also write yourplugins to generate custom outputs that match your needs.

You can try this tool live on your browser and see some useful examples. Check outGraphQL Code Generator Live Examples.

We currently support and maintainthese plugins (TypeScript, Flow, React, Angular, MongoDB, Stencil, Reason, and some more), and there is an active community that writes and maintains custom plugins.

You can find the complete instructions inGraphQL Code Generator website.

Start by installing the basic deps of GraphQL Codegen:

yarn add graphqlyarn add -D @graphql-codegen/cli

GraphQL Code Generator lets you setup everything by simply running the following command:

yarn graphql-codegen init

Question by question, it will guide you through the whole process of setting up a schema, selecting plugins, picking a destination of a generated file, and a lot more.

If you wish tomanually setup codegen, follow these instructions.

Besides ourdocs page, feel free to go through our published Medium articles to get a better grasp of what GraphQL Code Generator is all about:

• All available plugins & presets

If this is your first time contributing to this project, please do read ourContributor Workflow Guide before you get started off.

Feel free to open issues and pull requests. We're always welcome support from the community.

For a contribution guide specific to this project, please refer to:http://the-guild.dev/graphql/codegen/docs/custom-codegen/contributing.

Help us keep GraphQL Code Generator open and inclusive. Please read and follow ourCode of Conduct as adopted fromContributor Covenant

MIT