Elliott — your portfolio, on your device 💼
Elliott is a simple way to see everything you hold in one view: stocks, crypto, and savings you describe yourself (like a term deposit). What you type in stays on your computer—there is no Elliott account database of your positions. The app only reaches out to public price sources so the numbers can update; you stay in control of what gets stored locally.
| Doc | Purpose |
|---|---|
| docs/architecture.md | How state, persistence, and market data fit together |
| docs/constraints.md | Hard rules (no app backend, client-side data, allowed sources) |
| AGENTS.md | Notes for contributors and coding agents (stack + conventions) |
- Next.js 16+ (App Router), TypeScript strict, React 19
- Material UI 9 + Emotion +
@mui/material-nextjs(App Router integration) - Jotai — portfolio + UI state
- TanStack Query — network caching and refetch for quotes and charts
- idb — IndexedDB (portfolio + cached quote snapshots)
- lightweight-charts — price charts
npm install
npm run devOpen http://localhost:3000.
Copy env.example to .env.local and set only what you need:
cp env.example .env.local| Variable | Why |
|---|---|
TWELVEDATA_API_KEY |
Server-only; stronger equity quotes/charts than the public demo key |
CORSFIX_API_KEY |
Server-only; improves IOL listing/UDF fetch when direct server requests fail |
IOL_LISTING_EXCHANGES |
Server-only; comma-separated venues for IOL-first quotes/charts (default: BCBA, NYSE, NASDAQ, AMEX, ARCA, BATS). Set empty to disable IOL-first. |
IOL_UDF_CHARTS |
Server-only; set to 0 to skip IOL UDF daily charts (TwelveData-only). BCBA_IOL_CHARTS=0 is a legacy alias. |
| Command | Description |
|---|---|
npm run dev |
Development server |
npm run build |
Production build |
npm run start |
Production server |
npm run lint |
ESLint |
npm run test |
Vitest (unit tests) |
Elliott builds as a standard Next.js app on Vercel. Do not commit .env or .env.local; set the same variables from env.example in the Vercel project Environment Variables UI, then redeploy.
See docs/deploy-vercel.md for the full checklist and troubleshooting.
- Portfolio add / edit / delete with automatic save in the browser
- Live-style prices (polling + optional IndexedDB cache for last-known values)
- KPIs: total value, optional gain/loss vs average cost, estimated 24h change, allocation
- Charts per holding (crypto and equity sources; IOL-listed exchanges can use IOL daily history before TwelveData)
- Opportunity hints from small, documented rules (concentration, moves, drawdown vs cost)
- Fixed income positions modeled from your own rate and dates (no external feed)
Private project (private: true in package.json); adjust as needed.