negt

README

negt

NEGT stands for Node-Express-GraphQL-Template.
CLI-App can auto generate graphql models and resolvers by your requirements..
For example :- If you want to make graphql models and it's resolvers please provide the details for the questions.
It will auto generate graphql schema and resolvers by itself.

Quick Start

1. Initailise a new go module

   mkdir example
   cd example
   go mod init example
   

2. Add negt package to your module.

   go get github.com/wednesday-solutions/negt@latest
   

3. For installing negt,

   go install github.com/wednesday-solutions/negt@latest
   

This will install the negt command to your $GOPATH/bin directory.

For Negt users

If you want use the negt command for Node-Express-GraphQL-Template, just install negt by doing this (Before this you should make sure Go is already installed in your machine.),

go install github.com/wednesday-solutions/negt@latest

Usage

1. For seeing the command options in the terminal,

    negt
   
    negt help
   
    negt gqlgen
   

2. Then for initializing GraphQL models

   negt gqlgen init
   

If you are using Node-Express-GraphQL-Template, it will create directories server/gql/models otherwise gql/models.

1. Then for creating new GraphQL model

   negt gqlgen model
   

You will get some questions, please answer to the the questions.
If you are using Node-Express-GraphQL-Template, then select server/gql/models otherwise gql/models.
It will create GraphQL Model files in gql/models/<modelName>.
Or if you want to make in different directory, select Others.

Generating files

Files :-
    1. index.js                 - It contains all relations of the gql model.
    2. models.js                - It contains fields and GraphQLObjectType of the model.
    3. query.js                 - It contains query of the model.
    4. list.js                  - It contains connection and query list of the model.
    5. mutation.js              - It contains the mutation fields and mutation object.
    6. customCreateMutation.js  - If you need custom resolvers for the GraphQL model, you can say yes for the question in the CLI.
       If you said yes, then it will create 3 custom resolver files. This file contains the custom create mutation object.
    7. customUpdateMutation.js  - It contains the custom update mutation object.
    8. customDeleteMutation.js  - It contains the custom delete mutation object.

It will create its test files also in gql/models/<modelName>/tests directory.

Test files :-
    1. index.test.js                - It contains the test cases of index.js file. It checks the importing is working properly.
    2. models.test.js               - It contains the test case for type of the GraphQL model.
    3. query.test.js                - It contains the test case of GraphQL query.
    4. list.test.js                 - It contains the test case of GraphQL query list.
    5. mutation.test.js             - It contains the test cases of GraphQL mutations like creating, updating and deleting.
    6. pagination.test.js           - It contains the test case for checking the pagination of GraphQL queries is working properly.
       Most of the case, we don't need to change this file anymore. So it will create this test case in a different file.
    7. customCreateMutation.test.js - It contains the test case of custom create mutation resolver.
    8. customUpdateMutation.test.js - It contains the test case of custom update mutation resolver.
    9. customDeleteMutation.test.js - It contains the test case of custom delete mutation resolver.

Also, it will create mockData file for the model in utils/testUtils directory.

This project is released under the MIT License.