rsnext/examples/with-apollo-neo4j-graphql/README.md
Michael Webb 4faf579c4f
[EXAMPLES] Update with-apollo-neo4j-graphql (#44570)
We replace neo4j-graphql-js with @neo4j/graphql and update Apollo server to version 4.

This refactor also changes the code from Javascript to Typescript.



## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] [e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm build && pnpm lint`
- [x] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
2023-02-23 13:37:22 +00:00

3.6 KiB

Neo4j Example with GraphQL and Apollo

This is a simple setup for Next using Neo4j Database with GraphQL and Apollo. Neo4j's Movies dataset example is used to run the example.

Deploy your own

Once you have access to the environment variables you'll need, deploy the example using Vercel:

Deploy with Vercel

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-apollo-neo4j-graphql with-apollo-neo4j-graphql-app
yarn create next-app --example with-apollo-neo4j-graphql with-apollo-neo4j-graphql-app
pnpm create next-app --example with-apollo-neo4j-graphql with-apollo-neo4j-graphql-app

Configuration

Step 1. Create a Neo4j database

First, you'll need a Neo4j database. Neo4j Desktop and Neo4j Online Sandbox are good and free-to-use options.

Step 2. Add the movie graph model to the database

This example uses a database containing Movies, you can add it like so:

:play movie-graph

Also included is a Cypher movie sample query if needed.

Step 3. Set up environment variables

Next, copy the .env.local.example file in this directory to .env.local (which will be ignored by Git):

cp .env.local.example .env.local

Then set each variable on .env.local to match your database URI and credentials.

Deploy on Vercel

You can deploy this app to the cloud with Vercel (Documentation).

Deploy Your Local Project

To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.

Important: When you import your project on Vercel, make sure to click on Environment Variables and set them to match your .env.local file.

Deploy from Our Template

Alternatively, you can deploy using our template by clicking on the Deploy button below.

Deploy with Vercel

Notes

To learn more about how to use the Neo4j GraphQL Library, you can take a look at the documentation or check out the GitHub repository.