README.md

GRAPHQL CODEGEN (GRAPHQL CODE GENERATOR)

DESCRIPTION

EXAMPLE OF NODE.JS USING:

• GRAPHQL CODE GENERATOR (GRAPHQL CODEGEN) IS A TOOL THAT GENERATES CODE OUT OF YOUR GRAPHQL SCHEMA.
• GRAPHQL PLAYGROUND: A GRAPHICAL, INTERACTIVE AND IN-BROWSER GRAPHQL IDE.
• ALTAIR GRAPHQL CLIENT: A GRAPHICAL, INTERACTIVE AND IN-BROWSER GRAPHQL IDE.

PREREQUISITES

• NODEMON: FOLLOW THE INSTRUCTIONS HERE.
• EXPRESS: FOLLOW THE INSTRUCTIONS HERE.
• TYPESCRIPT: FOLLOW THE INSTRUCTIONS HERE.
• GRAPHQL MODULES: FOLLOW THE INSTRUCTIONS HERE.
• GRAPHQL SUBSCRIPTIONS: FOLLOW THE INSTRUCTIONS HERE.

REQUIRED PACKAGES

• FOR CODEGEN:

npm install -D @graphql-codegen/cli
npm install -D @graphql-codegen/graphql-modules-preset
npm install -D @graphql-codegen/typescript-resolvers
npm install -D @graphql-codegen/typescript
npm install -D @graphql-codegen/add

• FOR GRAPHQL PLAYGROUND:

npm install graphql-playground-html

• FOR ALTAIR GRAPHQL CLIENT:

npm install altair-static

CONFIGURATIONS

• CREATE THE COMAND npm run codegen BY INSERTING THE FOLLOWING LINE TO THE script PROPERTY IN package.json:

"codegen": "graphql-codegen --watch --config ./folderSource/folderTopics/folderGraphqlCodegen/folderApplication/folderCodegenConfigurations/codegen.yml",

EXAMPLE

• CREATE codegen.yml (IT IS POSSIBLE TO USE npx graphql-codegen init, BUT IT WAS CREATED MANUALLY).

• CREATE TYPE DEFINITIONS FROM GRAPHL SCHEMA:

npm run codegen

• RUN THE EXAMPLE:

npm run tsc-nodemon --jsfile=./folderDist/folderTopics/folderGraphqlCodegen/exampleGraphqlCodegen.js