rsnext/examples/with-neo4j
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00:00
..
components [ EXAMPLES ] Added with-neo4j (#16559) 2020-11-24 18:35:51 +00:00
lib [ EXAMPLES ] Added with-neo4j (#16559) 2020-11-24 18:35:51 +00:00
pages examples: Bump SWR to v2.0.0 (#44790) 2023-01-12 09:36:29 -08:00
public [ EXAMPLES ] Added with-neo4j (#16559) 2020-11-24 18:35:51 +00:00
styles [ EXAMPLES ] Added with-neo4j (#16559) 2020-11-24 18:35:51 +00:00
util Optimised Cypher queries in Neo4j example (#25973) 2021-07-19 20:18:40 +00:00
.env.local.example fix(38043): replace double slashes with hashtag for comment lines in … (#38044) 2022-06-27 00:04:05 +00:00
.gitignore Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
movie-sample.md [ EXAMPLES ] Added with-neo4j (#16559) 2020-11-24 18:35:51 +00:00
package.json examples: Bump SWR to v2.0.0 (#44790) 2023-01-12 09:36:29 -08:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04:00

Neo4j Example

This is a simple set up for Next using Neo4j Database with api routes. 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-neo4j with-neo4j-app
yarn create next-app --example with-neo4j with-neo4j-app
pnpm create next-app --example with-neo4j with-neo4j-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