Add neo4j example (#79)

* Add neo4j exaample
* Added more context on Neo4j GraphQL
* Add readme and update directory list

README.md

@@ -40,24 +40,29 @@ Each repository has a README with instructions on how to get started. If you get
 Here's a list of our current examples:
 
 - [with-airtable-prismjs-axios](./with-airtable-prismjs-axios)
+- [with-angular](./with-angular)
 - [with-apollo](./with-apollo)
 - [with-auth0](./with-auth0)
 - [with-cockroachdb](./with-cockroachdb)
 - [with-coingecko](./with-coingecko)
-- [with-firebase](./with-firebase)
 - [with-fauna](./with-fauna)
+- [with-firebase](./with-firebase)
 - [with-gatsby](./with-gatsby)
 - [with-google-analytics](./with-google-analytics)
 - [with-google-login-faunadb](./with-google-login-faunadb)
 - [with-gql-voyager](./with-gql-voyager)
 - [with-graphql](./with-graphql)
+- [with-hackernews](./with-hackernews)
 - [with-harperdb](./with-harperdb)
 - [with-interface](./with-interface)
 - [with-jsonplaceholder](./with-jsonplaceholder)
 - [with-mock-data](./with-mock-data)
 - [with-mongodb-atlas](./with-mongodb-atlas)
 - [with-mysql](./with-mysql)
+- [with-neo4j](./with-neo4j)
+- [with-neon](./with-neon)
 - [with-next](./with-next)
+- [with-openai](./with-openai)
 - [with-planetscale](./with-planetscale)
 - [with-postgresql](./with-postgresql)
 - [with-python](./with-python)
@@ -66,6 +71,7 @@ Here's a list of our current examples:
 - [with-rest](./with-rest)
 - [with-rss](./with-rss)
 - [with-shopify-agilitycms](./with-shopify-agilitycms)
+- [with-snowflake](./with-snowflake)
 - [with-spectaql](./with-spectaql)
 - [with-stepzen-github-action](./with-stepzen-github-action)
 - [with-sveltekit](./with-sveltekit)

with-neo4j/.sample.env

@@ -0,0 +1,2 @@
+NEO4J_CONNECT_URL=
+NEO4J_PASSWORD=

with-neo4j/README.md

@@ -0,0 +1,124 @@
+# StepZen Example: `with-neo4j`
+
+## Introduction
+
+This project builds a GraphQL API connected to Neo4j using StepZen. Neo4j is a graphq database build for develooers, read the [complete blog post for this project here](https://neo4j.com/developer-blog/api-development-neo4j-graphql-stepzen/).
+
+## Getting Started
+
+You'll need to create a [StepZen account](https://stepzen.com/request-invite) first. Once you've got that set up, [git clone](https://www.atlassian.com/git/tutorials/setting-up-a-repository/git-clone) this repository onto your machine and open the working directory:
+
+```bash
+git clone https://github.com/stepzen-dev/examples.git
+cd examples/with-neo4j
+```
+
+Before you can run this example, you need to have a Neo4j instance. Which you can set up in the next section.
+
+## Set up Neo4j
+
+![Neo4j Sandbox Dashboard](./assets/neo4j-sandbox-new-database.png)
+
+1. Go to https://sandbox.neo4j.com/ and sign up for a new account or sign in to your existing account
+2. You will be taken to the sandbox dashboard after creating your account. Click on the "Movies" dataset to set up a new project from here.
+3. Once you have selected the "movies" dataset, click on the "Create" button. This will create a new Neo4j graph database based on the movie dataset.
+
+After these steps, we will have a Neo4j sandbox environment with a pre-populated movies database. We can now start building our GraphQL API using the Neo4j GraphQL Library.
+
+![Neo4j Sandbox credentials](./assets/neo4j-sandbox-credentials.png)
+
+You should paste these credentials in a new file called `.env`:
+
+```text
+NEO4J_CONNECT_URL=
+NEO4J_PASSWORD=
+```
+
+## Run the Neo4j GraphQL Library
+
+In the project directory, you can run:
+
+```bash
+npm install
+npm start
+```
+
+This will run the Neo4j GraphQL Library based on the pre-generated GraphQL schema based on the contents of the Movies Neo4j graph database. You can also choose to run `npm run generate` and in this case the Neo4j GraphQL library will introspect the database and generate a GraphQL schema based on the labels and relationships in the database.
+
+The GraphQL API will be available at `http://localhost:4000/graphql`. 
+
+## Set up StepZen
+
+Open your terminal and [install the StepZen CLI](https://stepzen.com/docs/quick-start/install-and-setup):
+
+```bash
+npm install -g stepzen
+```
+
+We'll be using StepZen using the Docker image as the Neo4j GraphQL Library is running locally. You can run the following command to start using Docker:
+
+```bash
+stepzen service start
+```
+
+This command will start the StepZen service in a Docker container and create a local configuration file at `~/.stepzen/stepzen-config.local.yaml`.
+
+3. Log in to the StepZen CLI pointing to the local configuration:
+
+```bash
+stepzen login --config ~/.stepzen/stepzen-config.local.yaml
+```
+
+We can now use StepZen for local development and the CLI like when running StepZen in the cloud. 
+
+4. In the directory `stepzen`, you can run:
+
+```bash
+stepzen start
+```
+
+This will start the GraphQL API at `http://localhost:5000/api/with-neo4j/__graphql`. The StepZen GraphQL schema is pointed towards `http://host.docker.internal:4000/graphql` which is the Neo4j GraphQL Library running locally.
+
+## Add the New York Times API
+
+The file `sample.config.yaml` contains the configuration for the New York Times API. You can copy the contents of this file to `stepzen/config.yaml` and replace the value for `api-key` with your own API key.
+
+To get an API Key you need to sign up for a New York Times API key by following the instructions on the [developer page](https://developer.nytimes.com/get-started). After creating an account, you can [create an application](https://developer.nytimes.com/my-apps) and find the API key for the free New York Times API here.
+
+
+```yaml
+configurationset:
+  - configuration:
+      name: nyt
+      apiKey: ADD_YOUR_API_KEY_HERE
+```
+
+After adding the API key, you can run `stepzen service start` again and the New York Times API will be available at `http://localhost:5000/api/with-neo4j/__graphql`.
+
+## Try out the GraphQL API
+
+You can now run the following query to get the top 3 movies and their reviews:
+
+```graphql
+{
+  movies(options: {limit: 3}) {
+    title
+    reviews {
+        headline
+      }
+  }
+}
+```
+
+> Don't forget to set the value for `limit` to 3, as the NYT REST API only allows a set number of requests per time.
+
+## Learn More
+
+You can learn more in the [StepZen documentation](https://stepzen.com/docs). Questions? Head over to [Discord](https://discord.gg/9k2VdPn2FR) or [GitHub Discussions](https://github.com/stepzen-dev/examples/discussions) to ask questions.
+
+
+
+
+
+
+

with-neo4j/init.js

@@ -0,0 +1,27 @@
+const { toGraphQLTypeDefs } = require("@neo4j/introspector")
+const neo4j = require("neo4j-driver");
+const fs = require('fs');
+const path = require("path");
+
+require('dotenv').config()
+
+const driver = neo4j.driver(
+    process.env.NEO4J_CONNECT_URL,
+    neo4j.auth.basic("neo4j", process.env.NEO4J_PASSWORD)
+);
+
+const sessionFactory = () => driver.session({ defaultAccessMode: neo4j.session.READ })
+
+async function main() {
+    fs.exists(path.join(__dirname, "neo4j"), exists => {
+        if (!exists) {
+            fs.mkdirSync(path.join(__dirname, "neo4j"));
+        }
+    });
+
+    const typeDefs = await toGraphQLTypeDefs(sessionFactory)
+
+    fs.writeFileSync('neo4j/schema.graphql', typeDefs)
+    await driver.close();
+}
+main()

with-neo4j/neo4j/schema.graphql

@@ -0,0 +1,31 @@
+interface ActedInProperties @relationshipProperties {
+	roles: [String]!
+}
+
+type Movie {
+	peopleActedIn: [Person!]! @relationship(type: "ACTED_IN", direction: IN, properties: "ActedInProperties")
+	peopleDirected: [Person!]! @relationship(type: "DIRECTED", direction: IN)
+	peopleProduced: [Person!]! @relationship(type: "PRODUCED", direction: IN)
+	peopleReviewed: [Person!]! @relationship(type: "REVIEWED", direction: IN, properties: "ReviewedProperties")
+	peopleWrote: [Person!]! @relationship(type: "WROTE", direction: IN)
+	released: BigInt!
+	tagline: String
+	title: String!
+}
+
+type Person {
+	actedInMovies: [Movie!]! @relationship(type: "ACTED_IN", direction: OUT, properties: "ActedInProperties")
+	born: BigInt
+	directedMovies: [Movie!]! @relationship(type: "DIRECTED", direction: OUT)
+	followsPeople: [Person!]! @relationship(type: "FOLLOWS", direction: OUT)
+	name: String!
+	peopleFollows: [Person!]! @relationship(type: "FOLLOWS", direction: IN)
+	producedMovies: [Movie!]! @relationship(type: "PRODUCED", direction: OUT)
+	reviewedMovies: [Movie!]! @relationship(type: "REVIEWED", direction: OUT, properties: "ReviewedProperties")
+	wroteMovies: [Movie!]! @relationship(type: "WROTE", direction: OUT)
+}
+
+interface ReviewedProperties @relationshipProperties {
+	rating: BigInt!
+	summary: String!
+}