Skip to content

beatalipska/kym

Repository files navigation

kym – Know Your Money

Tezos & Etherlink portfolio dashboard that lets you see, at a glance:

  • Total portfolio value (USD)
  • Tezos: spendable vs staked XTZ and selected DeFi tokens
  • Per‑wallet breakdown for your main and Temple Tezos wallets

Prerequisites

  • Node.js 20+
  • npm

Install dependencies

From the project root:

npm install

Running the app (development)

You need two terminals: one for the API server and one for the frontend.

1. Start the API (Tezos portfolio backend)

npm run api

This starts an Express server on http://localhost:3001 exposing:

  • GET /api/portfolio – aggregates Tezos balances, staking and DeFi tokens

2. Start the frontend (React + Vite)

In another terminal:

npm run dev

Open the app at:

http://localhost:5173

Login

Currently there is a simple demo login:

  • Email: you@example.com
  • Password: demo1234

Once logged in you’ll see:

  • Top cards for Total portfolio, Tezos, and Etherlink
  • A detailed breakdown table with:
    • Chain
    • Wallet name (Main Wallet / Temple Wallet)
    • Category (wallet / staked / defi)
    • Token, amount, price and value

Wallets included (hard‑coded for now)

  • Main Tezos wallet: tz2TYtyJR9tKkHw9r8sUecPaiDxm43pB9QWs
  • Temple Wallet (Tezos): tz1PG1VKdDAyHC9zdLzjDTFAb5Qop36MZUDE
  • Etherlink wallet: 0xe1F0D4Cd256F8467EF6DD0a4EA2E6f2B767A1d96

You can change these addresses in:

  • server.ts – for backend aggregation
  • src/App.tsx – for the display footer

Notes & limitations

  • Tezos DeFi tracking currently supports a small token whitelist:
    • uUSD, YOU, stXTZ
  • Most NFTs / collectibles are not priced yet and may not appear in totals.
  • Etherlink support is stubbed and will be expanded in future iterations.

Scripts

npm run dev   # Start frontend (Vite)
npm run api   # Start backend API (Express + ts-node)
npm run build # Build frontend for production

About

Know Your Money

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages