Skip to content

Commit

Permalink
Add wormhole refresh endpoint and docker logs help to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
madmikeross committed Dec 23, 2023
1 parent faeeedd commit 1770832
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,32 @@
# eve-graph
An application for finding optimal routes between systems in EVE Online.

A route finding application for navigating in EVE Online.

## How to use

### Running with Docker
Make sure you have Docker engine installed, then run `docker compose up`. This should build a container for Neo4j,

Make sure you have Docker engine installed, then run `docker compose up -d`. This should build a container for Neo4j,
install the graph-data-science plugin, and also build a container for the eve-graph app.

On start, eve-graph will attempt to synchronize systems and stargates with ESI before accepting requests. If routing
isn't working properly, inspect the logs for the api container.
On start, eve-graph will attempt to synchronize systems and stargates with [ESI](https://esi.evetech.net/ui/) before
accepting requests. If routing isn't working properly, inspect the logs for the api container
`docker logs eve-graph-api-1`.

### Collecting data
When you first start eve-graph, you will need to exercise the wormhole refresh endpoint to hydrate the database
ephemeral J-space connections. Also, every time you restart the database, the in memory "graph" of data that the gds
plugin uses will need to be rebuilt, calling to refresh wormholes also refreshes this "graph" (and you should call to
refresh wormholes regularly).

When you first start eve-graph, you will need refresh wormhole connections by making a POST request to
`localhost:8008/wormholes/refresh`. Also, every time you restart the database, the in memory "graph" of data that the
gds plugin uses will need to be rebuilt, calling to refresh wormholes also refreshes this "graph" (and you should call
to refresh wormholes regularly).

### Finding the shortest route

If you want to find the shortest route between two systems, say Jita and Amarr, simply issue a get request to
`localhost:8008/shortest-route/Jita/to/Amarr` (can be done in a browser, with curl, or via Postman).

### Finding a safe route

First you need to update the jump risks of each system by making a POST request to `localhost:8008/systems/risk`. This
will fetch kills and jumps for all systems in the last hour, and use those values to assign a risk to jumping into each
system. If you want to find a safe route between two systems, say Jita and Amarr, issue a get request to
Expand Down

0 comments on commit 1770832

Please sign in to comment.