Merge branch 'master' into modernize

Author: djhi

Makefile

@@ -22,7 +22,7 @@ format: ## Format the source code
 	@yarn run format
 
 run: ## Launch server with example data
-	@yarn run server
+	@node ./bin/json-graphql-server.cjs example/data.js
 
 build: ## Build production release
 	@yarn run build

README.md

@@ -8,20 +8,15 @@ Get a full fake GraphQL API with zero coding in less than 30 seconds.
 > I'd love to learn GraphQL, but it seems that I first have to read a book about GraphQL Types and Queries, then install a gazillion npm packages.
 > - About every developer
 
-Start playing with GraphQL right away with `json-graphql-server`, a testing and mocking tool for GraphQL. All it takes is a JSON of your data.
+Start playing with GraphQL right away with `json-graphql-server`, a testing and mocking tool for GraphQL written in Node.js. All it takes is a JSON of your data.
 
 Inspired by the excellent [json-server](https://github.com/typicode/json-server).
 
-## Example
-
-Follow the guide below starting from scratch, or see the example live on StackBlitz:
+## Usage
 
 [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/fork/json-graphql-server)
 
-
-Create a `db.js` file.
-
-Your data file should export an object where the keys are the entity types. The values should be lists of entities, i.e. arrays of value objects with at least an `id` key. For instance:
+Create a `db.js` file that exports an object where the keys are the entity types. The values should be lists of entities, i.e. arrays of value objects with at least an `id` key. For instance:
 
 ```js
 module.exports = {
@@ -40,14 +35,23 @@ module.exports = {
 }
 ```
 
-Start the GraphQL server on localhost, port 3000.
+Use the `npx json-graphql-server <db_file_name>` command to start the GraphQL server on localhost, port 3000.
 
 ```sh
 npx json-graphql-server db.js
 ```
 
-To use a port other than 3000, you can run `json-graphql-server db.js --p <your port here>`
-To use a host other than localhost, you can run `json-graphql-server db.js -h <your host here>` or `--host <your host here>`
+To use a different port, use the `--port` or `-p` option:
+
+```
+npx json-graphql-server db.js --p 8080
+```
+
+To use a different host, use the `--host` or `-h` option: 
+
+```
+npx json-graphql-server db.js -h 127.0.0.1
+```
 
 Now you can query your data in graphql. For instance, to issue the following query:
 

bin/json-graphql-server.cjs

@@ -4,7 +4,7 @@ var express = require('express');
 var cors = require('cors');
 var { jsonGraphqlExpress } = require('../dist/json-graphql-server-node.cjs');
 var dataFilePath = process.argv.length > 2 ? process.argv[2] : './data.json';
-var data = require(path.join(process.cwd(), dataFilePath));
+var data = require(path.resolve(process.cwd(), dataFilePath));
 var PORT = process.env.NODE_PORT || 3000;
 var HOST = process.env.NODE_HOST || 'localhost';
 var app = express();

package.json

@@ -1,6 +1,6 @@
 {
     "name": "json-graphql-server",
-    "version": "3.1.0",
+    "version": "3.1.2",
     "type": "module",
     "main": "./dist/json-graphql-server.cjs",
     "module": "./dist/json-graphql-server.js",
@@ -53,14 +53,14 @@
         "lint-staged": "^15.2.2",
         "supertest": "^6.3.4",
         "typescript": "^5.5.4",
-        "vite": "^5.2.8",
+        "vite": "^5.4.12",
         "vitest": "^2.0.5"
     },
     "dependencies": {
         "@apollo/client": "^3.9.11",
         "@graphql-tools/schema": "^10.0.3",
         "cors": "^2.8.5",
-        "express": "^4.17.3",
+        "express": "^4.20.0",
         "graphql": "^16.8.1",
         "graphql-http": "^1.22.1",
         "graphql-type-json": "^0.3.2",
@@ -70,5 +70,6 @@
     },
     "bin": {
         "json-graphql-server": "bin/json-graphql-server.cjs"
-    }
+    },
+    "packageManager": "[email protected]+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

src/graphiqlHandler.ts

@@ -6,8 +6,8 @@ export const graphiqlHandler: Handler = (_, res) => {
     });
     return res.end(
         getGraphiqlHtml({
-            endpoint: '/',
-        }),
+            endpoint: '/graphql',
+        })
     );
 };
 
@@ -73,7 +73,6 @@ const getGraphiqlHtml = ({ endpoint }: { endpoint: string }) => `
       const root = ReactDOM.createRoot(document.getElementById('graphiql'));
       const fetcher = GraphiQL.createFetcher({
         url: '${endpoint}',
-        headers: { 'X-Example-Header': 'foo' },
       });
       const explorerPlugin = GraphiQLPluginExplorer.explorerPlugin();
       root.render(