Skip to content

A modern platform for visual, flexible, and extensible graph-based investigations. For cybersecurity analysts and investigators.

feat: docs

dextmorgn293781af97de
diff --git a/README.md b/README.md
index 87032d82..c822a7f6 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,7 @@ Don't want to read ? Got it. Here's your install instructions:
#### 1. Install pre-requisites
- Docker
+- Make
#### 2. Run install command
@@ -20,6 +21,15 @@ cd flowsint
make prod
```
+Before running this command, setup your different API keys in the `.env.example` file:
+
+```bash
+HIBP_API_KEY= # HaveIBeenPwned
+ETHERSCAN_API_KEY= #Etherscan
+WHOXY_API_KEY= # Whoxy
+...
+```
+
Then go to [http://localhost:5173/register](http://localhost:5173/register) and create an account. There are no credentials or account by default.