https://github.com/hemicharly/graphql-gateway-api

Server graphql gateway api
https://github.com/hemicharly/graphql-gateway-api

Last synced: 26 days ago
JSON representation

Server graphql gateway api

• Host: GitHub
• URL: https://github.com/hemicharly/graphql-gateway-api
• Owner: hemicharly
• Created: 2019-05-19T13:50:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-11T01:30:08.000Z (about 2 years ago)
• Last Synced: 2023-03-05T05:49:42.334Z (almost 2 years ago)
• Language: JavaScript
• Homepage:
• Size: 2.74 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 23
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![](https://i.imgur.com/Rp3O3Un.png) 

####    Getting started

1. Install NodeJS Dubnium LTS (10.15.3).  

  1.1. [Windows](https://nodejs.org/dist/v10.15.3/node-v10.15.3-x86.msi)  

  1.2. [Posix (Linux or MacOS)](http://nvm.sh)

2. Install your prefer IDE ([VSCode](https://code.visualstudio.com/Download) is extremely recommended).

3. Install the global dependencies (development only)  

  3.1. `npm i -g yarn` [See more](https://yarnpkg.com/).  

  3.2. `npm i -g standard` *VSCode "standard" extension dependency* [See more](https://standardjs.com/).  

  3.3. *[Optional]* Install the following extensions on VSCode workspace:  

    - [GraphQL](https://marketplace.visualstudio.com/items?itemName=Prisma.vscode-graphql)

    - [Standard](https://marketplace.visualstudio.com/items?itemName=chenxsan.vscode-standardjs)

	- [VSCode Icons](https://marketplace.visualstudio.com/items?itemName=vscode-icons-team.vscode-icons)

4. Clone this repository

- `git clone https://github.com/hemicharly/graphql-gateway-api.git`

5. Install the project dependencies

`yarn`

6. Delete `.git` folder to disassociate yourself from this project.

7. Use for this example the microservices A and B, clone the repositories

- `git clone https://github.com/hemicharly/graphql-microservicesA.git`

- `git clone https://github.com/hemicharly/graphql-microservicesB.git`

- `git clone https://github.com/hemicharly/graphql-gateway-rest-api.git`

####    Folder struct

The project is structured in the following syntax (root is the root directory of your project):

  - `root/build` is the build folder when you execute `yarn build`. See script section below. 

    

  - `root/coverage` is the "tests report" folder when you execute `yarn test`. See script section below.

  

  - `root/coverage/Icov-report/index.html` is the web application for tests report.

  - `root/logs` is the rotative logs folder.

    

  - `root/tasks` is the [Gulp](https://gulpjs.com/) tasks folder. 

  

  - `root/index.js` is the [entry point](https://stackoverflow.com/questions/32800066/what-is-entry-point-in-npm-init).

  - `root/introspection.js` is the [entry point](https://codeburst.io/nodejs-graphql-micro-services-using-remote-stitching-7540030a0753).

  

####    Scripts

See below all availables `package.json` scripts:

  - `yarn dev` start your application in development mode, with [nodemon](https://nodemon.io/) to restart on changes.

  

  - `yarn build` build your application to production mode, with [babel](https://babeljs.io/) parsing (ES6 to ES5). Pre-scripts: `yarn lint`.

  

  - `yarn test` run all test files matched by the pattern `*.test.js`. [See more](https://jestjs.io/).

  

  - `yarn test:watch` run tests in watch mode. [See](https://jestjs.io/docs/en/cli#watch).

  

  - `yarn lint` run `standard` for lint erros.

  

  - `yarn lint:fix` fix all lint errors automatically (unstable).