Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
QubitPi committed Nov 24, 2023
1 parent 1a35cdb commit fc399ec
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,15 @@ Browser has a subproject of re-usable components bundled together and exposed as

## Development

> There are 2 parts within this project
>
> 1. [browser](./src/browser)
> 2. re-usable graphing library, i.e. [neo4j-arc](./src/neo4j-arc)
>
> Each mantains a separate TS version. **Browser's TS version has to align with neo4j-arc's by setting a fixed version
> at latter's lower bound**. For example, if neo4j-arc's typescript version is `"typescript": "^4.6.2"`, then the
> browser's has be to the exact version of `"typescript": "4.6.2"`
Running Neo4j Browser locally requires Node.js 16 and for dependencies we use yarn (`npm install -g yarn`). To install
dependencies and then start the development server at `http://localhost:8080`:

Expand Down

0 comments on commit fc399ec

Please sign in to comment.