KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #dsh #dsh-plugin #ai-agent #codex #ai-agents #deepseek-harness #claude-code #cli #react #mcp

graph-explorer

★ 28 Open GitHub ↗

Graph Explorer

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Graph Explorer
Visualize and explore a large graph of money transactions.

## Table of Contents

* **[Architecture](#architecture)**
* **[Demo](#demo)**
* **[Installation](#installation)**
  * [Prerequisites](#prerequisites)
  * [Steps](#steps)
* **[Development](#development)**
  * [Flask Server](#flask-server)
  * [Frontend](#frontend)
* **[Credits](#credits)**
* **[License](#license)**

## Architecture

* JanusGraph 0.2.1
* ScyllaDB 2.2.0 (storage backend for JanusGraph)
* Elasticsearch 6.0.1 (index backend for JanusGraph)
* Python Flask server
* Vue.js
* d3.js v4 force layout

</br>
<div align="center">
<img src="docs/img/architecture.png" alt="architecture" width="400px">
</div>

## Demo
Start exploring the graph from any node (e.g. with *Amanda Walker*)
[https://graph-explorer.fr](https://graph-explorer.fr)

## Installation

### Prerequisites

* Docker CE >= 1.13.0
* docker-compose >= 1.10.0

Below is a step by step guide explaining how to install the app with sample data.
If you want to run it with your own data, just replace the following files with your owns:
* `janus/data/nodes.csv`
* `janus/data/links.csv`
*  `logstash/data/transactions.csv`

Data directories for Elasticsearch and ScyllaDB will be mounted in the `PROJECT_HOME/data`.

The different services in the `docker-compose` setup need to be started in a specific order. [`wait-for-it.sh`](https://github.com/vishnubob/wait-for-it) mechanisms (or alike) could be implemented in the future to allow running all the services in a one line command like `docker-compose --build up`.

#### Steps
1. Clone the repository
```
> git clone  git@github.com:entrepreneur-interet-general/graph-explorer.git
> cd graph-explorer
```
2. Download and build Docker images
```
> docker-compose build
```
3. Create data directories
```
mkdir -p data/elasticsearch data/scylla
chown -R 1000:1000 data/elasticsearch
```
4. Start Elasticsearch
```
> docker-compose up -d elasticsearch
```
5. Wait for Elasticsearch to be available on port `9200`
```
> curl localhost:9200/_cat/health
docker-cluster yellow 1 1 6 6 0 0 6 0 - 50.0%
```
6. Start ScyllaDB
```
> docker-compose up -d scylladb
```
7. Wait for ScyllaDB to be available
```
> docker-compose exec scylladb nodetool status
--  Address     Load       Tokens       Owns    Host ID                               Rack
UN  172.22.0.3  1.07 MB    256          ?       c961595a-ee52-4f94-baf3-74cdc5058af6  rack1
```
8. Start JanusGraph
```
> docker-compose up -d janus
```
If a previous janus container has not been shut down correctly, you might get the following error:
```
A JanusGraph graph with the same instance id [*] is already open. Might required forced shutdown.
```
In this case you can run a cleanup script and then restart the `janus` container.
```
> docker-compose run --no-deps janus bin/gremlin.sh -e scripts/clean.groovy
```
9.  Wait for JanusGraph to be available on port `8182`
```
> curl -XPOST -d '{"gremlin" : "1+1" }' localhost:8182
{"result":{"data":[2],"meta":{}}}
```
10. Create the graph schema and load nodes and edges into JanusGraph (do it only the first time or after deleting the data directory)
```
> docker-compose exec janus bin/gremlin.sh -e scripts/create_schema.groovy
> docker-compose exec janus bin/gremlin.sh -e scripts/load_data.groovy
```
11. Checks that nodes and edges have been loaded
```
> curl -XPOST -d '{"gremlin" : "g.V().count()" }' localhost:8182
{"result":{"data":[1606],"meta":{}}}

> curl -XPOST -d '{"gremlin" : "g.E().count()" }' localhost:8182
{"result":{"data":[2156],"meta":{}}}
```
12. Load raw transactions into Elasticsearch (do it only the first time or after deleting the data directoy)
```
> docker-compose up -d logstash
```
13. Check that transactions have been loaded in the `transactions` index
```
> curl localhost:9200/transactions/doc/_count
{"count":2156,"_shards":{"total":5,"successful":5,"skipped":0,"failed":0}}
```
14. Start the Flask server with Gunicorn
```
docker-compose up -d app
```
* Visit [http://localhost:5000](http://localhost:5000)

## Development

### Run the tests

* Unit tests
```
make test_unit
```

* Integration tests requiring ScyllaDB, Elasticsearch and Janus to be up and running with data
loaded from steps 10 and 12
```
make test_integration
```

### Flask server
* Start `Elasticsearch`, `ScyllaDB` and `JanusGraph` with `docker-compose ` as described in the installation steps.
* Create a vitualenv for this project with `Python` version 3.6.0 or higher.
* Install the dependencies
```
pip install -r requirements.txt
```
* Run `Flask` in development mode. This will reload the server on code changes.
```
FLASK_APP=api.app.py FLASK_ENV='development' CONFIG='api.config.Development' python -m flask run
```

### Frontend
* Make sure to use a version of `nodejs` higher than 8.0.0. We recomand using [`nvm`](https://github.com/creationix/nvm).
* Install the dependencies
```
npm install
```
* The project is built using webpack into the file `local/build.js`.
* Build the source once with:
```
npm run build
```
* Or watch for file changes with:
```
npm run watch
```

Visit [http://localhost:5000](http://localhost:5000) and start coding!

## Credits

Please visit the [Hopkins mission](https://entrepreneur-interet-general.etalab.gouv.fr/defis/2018/hopkins.html) page for more information.

## License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

graph-explorer

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README