Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
martinadellobuono authored Apr 12, 2023
1 parent 7c14026 commit bc06fcc
Showing 1 changed file with 14 additions and 19 deletions.
33 changes: 14 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) > [email protected]
```
npm i express
```
- [**body-parser**](https://www.npmjs.com/package/body-parser) > [email protected]
- [**ejs**](https://www.npmjs.com/package/ejs) > [email protected]
- [**express-validator**](https://www.npmjs.com/package/express-validator) > [email protected]
- [**formidable**](https://www.npmjs.com/package/formidable) > [email protected]
- [**neo4j-driver**](https://www.npmjs.com/package/neo4j-driver) > [email protected]
- [**@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:
Expand Down

0 comments on commit bc06fcc

Please sign in to comment.