Giter VIP home page Giter VIP logo

generator-jhipster-gql's Introduction

generator-jhipster-gql

npm version pipeline status

JHipster module, GraphQL integration for JHipster

Introduction

This is a JHipster module, that is meant to be used in a JHipster application. The module adds support for GraphQL to existing JHipster web applications which were built with the Node.js Blueprint. When run, this generator installs @nestjs/graphql for the server application and scaffolds resolvers for the user entity and all other entities present in the application. For the client application, @apollo/client is installed and all REST calls related to entities are replaced by corresponding GraphQL requests. Angular, React and Vue are supported.

Prerequisites

As this is a JHipster module, JHipster must already be installed. It is also highly recommended that the application is initially built with the Node.js Blueprint.

Installation

With NPM

To install this module:

npm install -g generator-jhipster-gql

To update this module:

npm update -g generator-jhipster-gql

Usage

Run the module

yo jhipster-gql

Options

GraphQL schema location

This option controls which schema is used for building the GraphQL typing information in the client application.

GraphQL endpoint

This option controls which GraphQL endpoint is called from the client application

GraphQL type definition

This options controls where the GraphQL types and selection sets are defined. In the default setup (GraphQL) this is achieved via GraphQL documents with the help of GraphQL Code Generator Typescript Operations. Alternatively, it is possible to store the definitions in TypeScript classes using graphql-typeop with the TypeScript option.

Enable GraphQL for a specific entity in the client application

yo jhipster-gql:entity-client-enable <ENTITY_NAME>

Disable GraphQL for a specific entity in the client application

yo jhipster-gql:entity-client-disable <ENTITY_NAME>

License

Apache-2.0 © Markus Glutting

generator-jhipster-gql's People

Contributors

glutengo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.