Skip to content

Update GraphQL server setup instructions #2218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: source
Choose a base branch
from
Open

Update GraphQL server setup instructions #2218

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/pages/graphql-js/running-an-express-graphql-server.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ app.listen(4000, () => {
});
```

Also, check your `package.json` file and ensure that `type` is set to `module`:

```json
{
"type": "module",
}
```

You can run this GraphQL server with:

```sh
Expand All @@ -59,7 +67,7 @@ At this point you will have a running GraphQL API; but you can't just visit it i

[GraphiQL](https://github.com/graphql/graphiql) is GraphQL's IDE; a great way of querying and exploring your GraphQL API.
One easy way to add it to your server is via the MIT-licensed [ruru](https://github.com/graphile/crystal/blob/main/grafast/ruru/README.md) package which bundles a prebuilt GraphiQL with some popular enhancements.
To do so, install the `ruru` module with `npm install --save ruru` and then add the following to your `server.js` file, then restart the `node server.js` command:
To do so, install the `ruru` module with `npm install --save ruru` and then add the following to your `server.js` file:

```js
import { ruruHTML } from "ruru/server";
Expand All @@ -71,6 +79,8 @@ app.get("/", (_req, res) => {
});
```

Now restart the `node server.js` command.

If you navigate to [http://localhost:4000](http://localhost:4000), you should see an interface that lets you enter queries;
now you can use the GraphiQL IDE tool to issue GraphQL queries directly in the browser.

Expand Down