rsnext/examples/with-neo4j
Steven 9f9214abe5
Updated create-next-app docs to include pnpm usage (#35755)
This PR updates the docs and examples for `create-next-app` to include pnpm usage.

The following script was used to update every example README:

```js
const fs = require('fs')
const examples = fs.readdirSync('./examples')

for (let example of examples) {
    const filename = `./examples/${example}/README.md`
    const markdown = fs.readFileSync(filename, 'utf8')
    const regex = new RegExp(`^yarn create next-app --example (.*)$`, 'gm')
    const output = markdown.replace(regex, (yarn, group) => {
        const pnpm = `pnpm create next-app -- --example ${group}`
        return `${yarn}\n# or\n${pnpm}`
    })
    fs.writeFileSync(filename, output)
}
```
2022-03-30 21:03:21 +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 Optimised Cypher queries in Neo4j example (#25973) 2021-07-19 20:18:40 +00: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 [ EXAMPLES ] Added with-neo4j (#16559) 2020-11-24 18:35:51 +00:00
.gitignore [ EXAMPLES ] Added with-neo4j (#16559) 2020-11-24 18:35:51 +00:00
movie-sample.md [ EXAMPLES ] Added with-neo4j (#16559) 2020-11-24 18:35:51 +00:00
package.json Optimised Cypher queries in Neo4j example (#25973) 2021-07-19 20:18:40 +00:00
README.md Updated create-next-app docs to include pnpm usage (#35755) 2022-03-30 21:03:21 +00: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 or Yarn to bootstrap the example:

npx create-next-app --example with-neo4j with-neo4j-app
# or
yarn create next-app --example with-neo4j with-neo4j-app
# or
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