Skip to content

Commit e04dd42

Browse files
committed
extend README
1 parent 3f564ab commit e04dd42

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,23 @@
33
[![Discord](https://img.shields.io/discord/1146782921294884966?style=flat-square)](https://discord.com/invite/6M4QwDXn2w)
44

55
## Getting Started
6+
67
[Live Demo](https://code-graph.falkordb.com/)
78

89
## Running locally
910

1011
### Run FalkorDB
12+
1113
Free cloud instance: https://app.falkordb.cloud/signup
1214

1315
Or by running locally with docker:
16+
1417
```bash
1518
docker run -p 6379:6379 -p 3000:3000 -it --rm falkordb/falkordb:latest
1619
```
1720

1821
### Config
22+
1923
Create your own `.env` file from the `.env.template` file
2024

2125
Start the server:
@@ -24,16 +28,21 @@ flask --app api/index.py run --debug
2428
```
2529

2630
### Creating a graph
31+
2732
Process a local source folder:
33+
2834
```bash
2935
curl -X POST http://127.0.0.1:5000/analyze_folder -H "Content-Type: application/json" -d '{"path": "<FULL_PATH_TO_FOLDER>", "ignore": [<OPTIONAL_IGNORE_LIST>]}' -H "Authorization: <.ENV_SECRET_TOKEN>"
3036
```
3137

3238
For example:
39+
3340
```bash
3441
curl -X POST http://127.0.0.1:5000/analyze_folder -H "Content-Type: application/json" -d '{"path": "/Users/roilipman/Dev/GraphRAG-SDK", "ignore": ["./.github", "./build"]}' -H "Authorization: OpenSesame"
3542
```
43+
3644
## Working with your graph
45+
3746
Once the source code analysis completes your FalkorDB DB will be populated with
3847
a graph representation of your source code, the graph name should be the same as
3948
the name of the folder you've requested to analyze, for the example above a graph named:
@@ -43,6 +52,8 @@ At the moment only the Python and C languages are supported, we do intend to sup
4352

4453
At this point you can explore and query your source code using various tools
4554
Here are several options:
46-
1. FalkorDB built-in UI
55+
56+
1. [Code-Graph UI](https://github.com/FalkorDB/code-graph)
57+
1. FalkorDB [Browser](https://github.com/FalkorDB/falkordb-browser/)
4758
2. One of FalkorDB's [clients](https://docs.falkordb.com/clients.html)
4859
3. Use FalkorDB [GraphRAG-SDK](https://github.com/FalkorDB/GraphRAG-SDK) to connect an LLM for natural language exploration.

0 commit comments

Comments
 (0)