From bc06fccfb29ef483f1259d37853baef47d417bd0 Mon Sep 17 00:00:00 2001 From: martinadellobuono <34475729+martinadellobuono@users.noreply.github.com> Date: Wed, 12 Apr 2023 08:33:16 +0200 Subject: [PATCH] Update README.md --- README.md | 33 ++++++++++++++------------------- 1 file changed, 14 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 1c279762e..87a9dffcc 100644 --- a/README.md +++ b/README.md @@ -8,34 +8,29 @@ The project is ongoing and under development. Clone this repository using the URL https://github.com/martinadellobuono/shivadharma-neo4j.git or download the folder. -The project works with: +The project works with these ***requirements***: - [**Node.js**](https://nodejs.org/en/) v16.14.2 -- [**Express**](https://www.npmjs.com/package/express) > express@4.17.1 -``` -npm i express -``` -- [**body-parser**](https://www.npmjs.com/package/body-parser) > body-parser@1.19.0 -- [**ejs**](https://www.npmjs.com/package/ejs) > ejs@3.1.6 -- [**express-validator**](https://www.npmjs.com/package/express-validator) > express-validator@6.14.0 -- [**formidable**](https://www.npmjs.com/package/formidable) > formidable@1.2.6 -- [**neo4j-driver**](https://www.npmjs.com/package/neo4j-driver) > neo4j-driver@4.4.4 -- [**@tarekraafat/autocomplete.js**](https://www.npmjs.com/package/neo4j-driver) > tarekraafat/autocomplete.js@^10.2.7 - -Packages can be installed with [**NPM**](https://www.npmjs.com/). +- [**Neo4j**](https://neo4j.com/download/) @4.4.1 + +Packages can be installed by running **setup.sh**. After installing the required packages: - Download **Neo4j Desktop**: https://neo4j.com/download/ - Create a new **Project** - Click on the **Add** button -- Select **Remote connection** -- Insert the **Connection URL**: bolt://localhost:7687 -- Insert the credentials: - **Username**: neo4j - **Password**: 123456 +- Select **Local DBMS** +- Set **bolt://localhost:7687** as **Connect URL** +- Choose a **user** and a **password** +- Insert the credentials in .env: + **Username**: NEO4J_USER = insert the user set in the db + **Password**: NEO4J_PW = insert the password set in the db +- In .env add: +API_KEY = your_personal_api_key +To set the API key to access the Create an edition functionalities. - Run the application locally: **nodemon app.js** -- Open the application in your browser: **http://0.0.0.0:3000/** +- Open the application in your browser: **http://0.0.0.0:80/** ## Neo4j Graph In the application it is possible to create and store data in the Neo4j database, where they are structured as a graph. To create data and check the resulting graph, it is necessary to: