Merge pull request #10 from neo4j-graphacademy/devcontainer

devcontainer configuration

Author: adam-cowley

.devcontainer/devcontainer.json

@@ -0,0 +1,27 @@
+{
+	"name": "Build a Neo4j-backed Chatbot with TypeScript",
+	"image": "mcr.microsoft.com/devcontainers/typescript-node",
+	"postCreateCommand": "bash .devcontainer/post_create.sh",
+    "portsAttributes": {
+		"3000": {
+		"label": "Application",
+		"onAutoForward": "openPreview"
+		}
+	},
+	"forwardPorts": [
+		3000
+		],
+	"customizations": {
+		"codespaces": {
+			"openFiles": [
+				"SETUP.md",
+				".env.example"
+				]
+		},
+		"vscode": {
+			"extensions": [
+				"formulahendry.code-runner"
+				]
+		}
+	}
+}

.devcontainer/post_create.sh

@@ -0,0 +1 @@
+npm install --include=dev

.env.example

@@ -1,3 +1,4 @@
+# Create a copy of this file named `.env.local` and fill in the values before running the application.
 NEO4J_URI="bolt://123.45.678.90:7687"
 NEO4J_USERNAME="neo4j"
 NEO4J_PASSWORD="three-word-password"

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.gitpod.yml

@@ -0,0 +1,18 @@
+# Setup
+
+This repository accompanies the [Build a Neo4j-backed Chatbot with TypeScript](https://graphacademy.neo4j.com/courses/llm-chatbot-typescript/) on [GraphAcademy](https://graphacademy.neo4j.com).
+
+When the devcontainer is created, such as in a GitHub codespace, all the required software and packages will be installed.
+
+Follow the [Setup Instructions in GraphAcademy](https://graphacademy.neo4j.com/courses/llm-chatbot-typescript/1-project-setup/2-setup/) to get started.
+
+You will need to:
+
+1. Create a new [`.env.local`](.env.local) file and copy the contents of the [`.env.example`](.env.example) file into it
+2. Update the environment values in the [`.env`](.env) file with the values in the [Setup Instructions](https://graphacademy.neo4j.com/courses/llm-chatbot-typescript/1-project-setup/2-setup/)
+
+You can run the application using the command:
+
+```bash
+npm run dev
+```