dirtydishes/islandflow
1
0
Fork 0
Code Issues 2 Pull requests 4 Projects Releases Packages Wiki Activity Actions 1

Add env example and require Alpaca creds from env

Browse source 
- add .env.example with ingest/config defaults
- warn on missing Alpaca/Databento envs and remove hardcoded Alpaca defaults
- document .env setup in README
- allow .env.example to be tracked
This commit is contained in:
dirtydishes 2025-12-29 14:49:45 -05:00
parent baaadcf105
commit 3eb7dc9211
4 changed files with 58 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -14,10 +14,12 @@ Done now (in repo):
- Synthetic options/equity prints published to NATS and persisted to ClickHouse
- Deterministic option FlowPacket clustering (time window) + persistence
- API: REST for prints/flow packets, WS for live options/equities/flow, replay endpoints
- UI: live tapes for options/equities/flow + replay toggle + pause controls
- UI: live tapes for options/equities/flow + replay toggle + pause controls + replay time/completion
- Databento historical replay adapter (options) with symbol mapping
- Alpaca options adapter (dev-only, bounded contract list)
In progress / blocked:
- Live data adapters (requires licensed data source)
- Live data adapters beyond dev-only feeds (requires licensed data source)
- Rolling stats and advanced clustering
Not started:
@ -84,6 +86,9 @@ Install dependencies:
Start infra:
- `docker compose up -d`
Create env file:
- Copy `.env.example` to `.env` and fill in the API keys you plan to use.
Start everything (infra + services + web):
- `bun run dev`