Neo4j+GraphQL Starter

Immediately start building a GraphQL API on Vercel backed by a Neo4j AuraDB instance.

Prerequisites

As you need to provide the credentials as environment variables in order to deploy the GraphQL API, you at least need to have set up a Neo4j AuraDB instance.

If you have not yet created an account on Vercel, you will be prompted to create one before being able to clone and deploy the project.

In addition you need the following development tools installed:

• Node.js >v16.x and npm >v8.x
• Vercel CLI >v27.x

Getting Started

Click the deploy button and follow the instructions to clone the repository and deploy the API. After the API has been successfully deployed, the you will be able to interact with it at https://<deployment-url>/graphql. However, the preview in Vercel will display a “Not found” page.

Note: unless you have deployed the movies sample database you will need to update the GraphQL type definitions in order to interact with your database.

Next Steps

Make any required additional changes in the project settings in Vercel:

• Assign domains to your production deployments and/or Git branches.
• Configure (additional) build/runtime environment variables.
• (Optionally) add 3rd party integrations to the project (e.g. monitoring, log drain, observability tools).

Local Development

After cloning the newly created repository to your own machine, link the local repository with Vercel first:

vercel link
? Set up “<path/to/repository>”? [Y/n] y
? Which scope should contain your project? <your-team>
? Found project “<your-team/your-project>”. Link to it? [Y/n] y

vercel env pull

After successfully linking the project, you’re able to run and develop locally through Vercel by running the following commands:

npm install
npm start

Documentation

• Neo4j JavaScript Driver: learn more about how to manage the connection to your Neo4j AuraDB instance.
• Neo4j GraphQL Library: learn more about how to work with Neo4j and GraphQL.
• GraphQL Yoga: learn more about how to configure and manage the GraphQL server.
• Vercel: learn more about how to configure, deploy and manage the API.

Additional Tools

• Neo4j GraphQL Toolbox: generate GraphQL type definitions from and interact with an existing database.
• @neo4j/introspector: programmatically generate GraphQL type definitions from an existing database.
• Envelop: additional library and set of plugins for customizing the GraphQL execution layer.
• GraphQL Tools: additional set of tools for building a GraphQL API.