Your Environment

We have created a repository for this workshop. It contains the starter code and resources you need.

A blank Neo4j Sandbox instance has also been created for you to use during this course.

You can open a Neo4j Browser window throughout this course by clicking the Toggle Sandbox button in the bottom right-hand corner of the screen.

Get the code

You can use Gitpod as an online IDE and workspace for this workshop. It will automatically clone the workshop repository and set up your environment.

Open Gitpod workspace

You will need to log in with a Github, Gitlab, or Bitbucket account.

Alternatively, you can clone the repository and set up the environment yourself.

Develop on your local machine

You will need Node.js version 20.11.0 or above installed and the ability to install packages using npm.

Clone the https://github.com/neo4j-graphacademy/genai-workshop-typescript repository:

bash
git clone https://github.com/neo4j-graphacademy/genai-workshop-typescript

Install the required packages using npm:

bash
cd genai-workshop-typescript
npm install --include=dev

Setup the environment

Create a copy of the .env.example file and name it .env.local.

Use the configuration below to create a .env.local file in the root folder.

env
Create a .env file
NEO4J_URI="bolt://{sandbox-ip}:{sandbox-boltPort}"
NEO4J_USERNAME="{sandbox-username}"
NEO4J_PASSWORD="{sandbox-password}"

OPENAI_API_KEY=[CHECK THE SLIDES]

NEXT_PUBLIC_CHATBOT_NAME=CityJS
NEXT_PUBLIC_CHATBOT_DESCRIPTION="The CityJS Chatbot"
NEXT_PUBLIC_CHATBOT_GREETING="Hello, I'm the CityJS Chatbot.  How can I help?"

I will provide an OpenAI API Key (OPENAI_API_KEY) for the duration of the workshop, or you can create your own at platform.openai.com.

Test your setup

You can test your setup by running the following command:

sh
npm run test:environment

If the tests pass, you are ready to go. If you have not, please shout!

Continue

When you are ready, you can move on to the next task.

Summary

You are now up and running and are ready to start the workshop.