chris/styx
chris/styx
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Adding a small abstract to README

Browse source
This commit is contained in:
Christopher Talib 2020-06-12 12:04:59 +02:00
parent 7f83f720d8
commit f161d60d2d
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,17 +1,19 @@
# Styx
## IMPORTANT
## What are we trying to solve
For development purposes, each time you restart Styx, the database and the
schema is dropped. Currently, this is hardcoded and used to make development
easier. Just so you know.
Styx is the passive sibling of Vader. When Vader allows users to get "on-demand"
data from connectors, Styx will just ingest streams and streams of data. Styx
will find things when they are happening on the contrary of retro-hunting, Styx
find patterns in the current events and flags them on the spot. It's not
retro-hunting, it's present-hunting or even future-hunting as we hope to find
actors movement when they happen.
## Prerequisites
Styx uses a couple of other services to run:
* Kafka for messaging (not implemented yet in the docker, but currently not
necessary)
* Kafka for messaging (not implemented yet in the docker, but currently not necessary)
* Dgraph for graph representation of results
* Docker-compose to launch everything
@ -35,7 +37,7 @@ docker run --rm -it -p 8080:8080 -p 9080:9080 -p 8000:8000 -v ~/dgraph:/dgraph d
go get -u gitlab.dcso.lolcat/LABS/styx
cd $GOPATH/src/gitlab.dcso.lolcat/LABS/styx
go build
docker-compose up -d # or the other command
docker-compose up -d # or the other docker command
./styx
```