Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 2 additions & 34 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This guide is written for someone who has never opened a terminal before. It wal

It works on **Windows 10/11** and **macOS**. Pick the section for your operating system in each step.

> **Just want to try it without installing anything?** Open the hosted version at **https://lifedashboard.app** (or whichever URL is pinned in this repo's "About"), click **Sign in**, and use your email for a magic-link login. The hosted version doesn't have the live OpenBB market data, the embedded SSH terminal, or a built-in LLM — those are all in this local install. See [`README.md`](./README.md) for the side-by-side comparison.
> **Just want to try it without installing anything?** Open the hosted version at **https://lifedashboard.app** (or whichever URL is pinned in this repo's "About"), click **Sign in**, and use your email for a magic-link login. The hosted version doesn't have the embedded SSH terminal or a built-in LLM — those are in this local install. See [`README.md`](./README.md) for the side-by-side comparison.

---

Expand Down Expand Up @@ -44,14 +44,6 @@ Git is what downloads the project from GitHub.

If macOS pops up a window offering to install the "Command Line Developer Tools", click **Install** and wait for it to finish. That includes Git.

### 1c. Python (optional — only if you want stock market data)

The dashboard's **Personal Finance** features work without Python. Python is only needed if you also want **Market Intelligence** (live stock, crypto, and economic data via OpenBB).

If you want it: install Python **3.9 to 3.12** from https://www.python.org/. On Windows, **check the box** that says "Add python.exe to PATH" on the first installer screen.

You can skip this for now and add it later.

---

## Step 2. Download the project
Expand Down Expand Up @@ -142,31 +134,7 @@ To stop the dashboard, return to the terminal and press **Ctrl+C** (on both Wind

---

## Step 5. Optional — Live market data (OpenBB)

Skip this section unless you specifically want the **Market Intelligence** view inside the Finance page.

1. Install OpenBB. In a terminal type:

```
pip3 install "openbb[all]"
```

(On Windows you may need `pip` instead of `pip3`.)

2. Open a **second** terminal and start the OpenBB API. Leave this terminal open while you use market data:

```
openbb-api --host 127.0.0.1 --port 6900
```

3. Back in the dashboard, go to **Settings → OpenBB** and confirm the host/port match (`127.0.0.1` and `6900`).

4. Some data providers require a free API key. Go to **Settings → Finance Data Providers**, click the registration link next to a provider (Alpha Vantage, FRED, Polygon, etc.), copy the key it gives you, and paste it into the matching field. Modules that use Yahoo Finance, SEC, and the Federal Reserve work without any key.

---

## Step 6. Common errors and how to fix them
## Step 5. Common errors and how to fix them

### "Cannot resolve module '@noble/hashes/scrypt'"

Expand Down
36 changes: 2 additions & 34 deletions INSTALL.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,6 @@ Git 用来从 GitHub 下载项目源代码。

如果系统弹窗提示安装 "命令行开发者工具",点击 **安装**,等待安装完成即可(其中已经包含 Git)。

### 1c. Python(可选 —— 仅用于股票/加密市场数据)

面板里的 **个人理财** 功能不需要 Python。只有当你想使用 **市场情报**(OpenBB 提供的实时股票、加密货币、宏观经济数据)时才需要它。

如果需要:从 https://www.python.org/ 安装 **3.9 到 3.12** 之间的版本。Windows 用户在安装第一屏务必**勾选** "Add python.exe to PATH"。

也可以先跳过,以后想用再装。

---

## 第 2 步:下载项目
Expand Down Expand Up @@ -115,7 +107,7 @@ PowerShell 默认会拦截未签名的脚本。**必须**用下面这种方式
powershell -ExecutionPolicy Bypass -File setup.ps1
```

如果最后看到绿色的 **"Setup complete!"** 就成功了。如果看到红色错误,跳到下面的 **第 6 步 — 常见错误**。
如果最后看到绿色的 **"Setup complete!"** 就成功了。如果看到红色错误,跳到下面的 **第 5 步 — 常见错误**。

---

Expand All @@ -140,31 +132,7 @@ npm run dev

---

## 第 5 步(可选):实时市场数据(OpenBB)

如果你不打算使用 Finance 页里的 **市场情报** 视图,可以直接跳过本节。

1. 安装 OpenBB。在终端输入:

```
pip3 install "openbb[all]"
```

(Windows 上若 `pip3` 不可用,用 `pip` 即可。)

2. 打开**第二个**终端,启动 OpenBB API。使用市场数据期间这个终端要一直保持开启:

```
openbb-api --host 127.0.0.1 --port 6900
```

3. 回到面板,进入 **设置 → OpenBB**,确认主机/端口与上面一致(`127.0.0.1` / `6900`)。

4. 部分数据源需要免费的 API Key。进入 **设置 → 财经数据源**,点击对应数据源旁的注册链接(Alpha Vantage、FRED、Polygon 等),把拿到的 Key 粘回对应输入框即可。Yahoo Finance、SEC、美联储这几个数据源**无需任何 Key**。

---

## 第 6 步:常见错误及解决方法
## 第 5 步:常见错误及解决方法

### "Cannot resolve module '@noble/hashes/scrypt'"

Expand Down
15 changes: 1 addition & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ There are **two ways to use it**:
| **Database** | Supabase Postgres (each user isolated) | SQLite file in `data/` |
| **AI assistant (Claw)** | Connect your own cloud server or lobster | Built-in OpenRouter LLM |
| **SSH terminal in Claw** | On — browser SSH for any cloud VM (no install) | On — direct SSH |
| **Live market data (OpenBB)** | Off — local install only | On with OpenBB sidecar |
| **Email (invoices)** | Resend (built-in) | Your SMTP (nodemailer) |
| **Cost** | Free for the demo URL | Free, runs on your hardware |

Expand All @@ -34,7 +33,6 @@ There are **two ways to use it**:
- Claw chat **once you pair a local lobster** (see below)

### What is **off by default** in the online version
- **Live market data** (OpenBB sidecar binds to `127.0.0.1:6900` — local install only).
- **Bundled LLM access** — the cloud build never ships an OpenRouter key. Connect your own server.
- **Local file picker** in Claw (`/api/claw/read-local-file`).

Expand Down Expand Up @@ -82,7 +80,6 @@ The local install is the original single-user experience. Everything runs on you
|----------|-----------|---------|----------|
| **Node.js** | Yes | v20 or later | [nodejs.org](https://nodejs.org/) — pick **LTS** |
| **Git** | Yes | any | [git-scm.com](https://git-scm.com/) |
| **Python** | Optional | 3.9–3.12 | [python.org](https://www.python.org/) — only for OpenBB market data |

```bash
node -v
Expand Down Expand Up @@ -117,15 +114,6 @@ npm run dev

Open [http://localhost:3000](http://localhost:3000). The SQLite databases (`data/dashboard.db`, `data/vault.db`) are created on first launch.

### Step 4 — Live market data (optional)

```bash
pip3 install "openbb[all]"
openbb-api --host 127.0.0.1 --port 6900 # leave this running
```

Then go to **Settings → OpenBB** in the app to confirm host/port. Some providers want a free API key — paste them under **Settings → Finance Data Providers**.

For the full step-by-step install, see [`INSTALL.md`](./INSTALL.md). For a tour of every feature, see [`USER_MANUAL.md`](./USER_MANUAL.md).

---
Expand All @@ -135,7 +123,7 @@ For the full step-by-step install, see [`INSTALL.md`](./INSTALL.md). For a tour
**Data** always lives in **Supabase Postgres** (`DATABASE_URL`). **Auth** is always Supabase (email + password, magic link, OAuth — see login + Settings → Account security).

```
DEPLOYMENT_MODE=local # default — ssh2, nodemailer, OpenBB, OpenRouter LLM (optional)
DEPLOYMENT_MODE=local # default — ssh2, nodemailer, OpenRouter LLM (optional)
DEPLOYMENT_MODE=cloud # hosted-style — Resend, lobsterd relay, browser crypto vault, no bundled LLM
```

Expand Down Expand Up @@ -176,7 +164,6 @@ lib/modules/<feature>/
- **shadcn/ui** + Tailwind CSS v4 + Lucide React
- **Recharts**, **xterm.js**, **BlockNote**, **Excalidraw**
- **OpenRouter** via OpenAI SDK (local mode only — cloud users connect their own lobster)
- **OpenBB** Python sidecar for market intelligence (local mode only)
- **Cloudflare Workers + Durable Objects** for the encrypted lobster relay (cloud mode)

## OpenClaw and Supabase
Expand Down
51 changes: 2 additions & 49 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

- **思维导图** — 交互式的人生可视化地图。添加分类(健康、职业、财务等)和条目,自由拖拽、连接、组织。
- **智能待办** — 根据思维导图自动生成,无需手动创建。
- **财务终端** — 个人财务管理 + [OpenBB](https://github.com/OpenBB-finance/OpenBB) 驱动的市场数据。涵盖股票、加密货币、经济指标和财经新闻
- **财务终端** — 个人财务管理:账户、收支、预算与投资持仓
- **计划** — 富文本编辑器,用于记录想法、计划和笔记。
- **Claw** — 内置 AI 助手,能理解你的面板数据。
- **发票** — 轻松向客户开具发票。
Expand All @@ -27,7 +27,6 @@
|------|-----------|---------|---------|
| **Node.js** | 是 | v20 或更高 | [nodejs.org](https://nodejs.org/) — 选择 **LTS** 版本 |
| **Git** | 是 | 任意版本 | [git-scm.com](https://git-scm.com/) |
| **Python** | 可选 | 3.9–3.12 | [python.org](https://www.python.org/) — 仅在需要财务市场数据时安装 |

**检查是否已安装:**

Expand Down Expand Up @@ -80,51 +79,6 @@ npm run dev

在浏览器中打开 [http://localhost:3000](http://localhost:3000)。就这么简单 — 数据库会在首次启动时自动创建。

### 第 5 步 — 财务市场数据(可选)

财务页面有两个模式:**个人财务**(立即可用,无需配置)和 **市场资讯**(需要 OpenBB)。

#### 5a. 安装 OpenBB

```bash
pip3 install "openbb[all]"
```

#### 5b. 启动 OpenBB API

在一个 **单独的终端** 中运行:

```bash
openbb-api --host 127.0.0.1 --port 6900
```

使用财务功能时请保持此终端运行。

#### 5c. 配置数据提供商 API 密钥

部分市场数据模块需要数据提供商的免费 API 密钥。未配置密钥时,模块会显示提示信息,告知你需要哪个密钥。

进入 **设置 → 财务数据提供商** 输入你的密钥。每个提供商的注册链接都直接显示在设置面板中。

| 提供商 | 解锁的功能 | 有免费额度? |
|-------|-----------|------------|
| [BizToc](https://api.biztoc.com) | 全球新闻 | 有 |
| [Benzinga](https://www.benzinga.com/apis) | 公司新闻 | 有 |
| [Financial Modeling Prep](https://financialmodelingprep.com) | ETF 数据、股票筛选器 | 有 |
| [Tradier](https://developer.tradier.com) | 期权链 | 有(沙盒模式) |
| [Polygon.io](https://polygon.io) | 额外市场数据 | 有 |
| [Alpha Vantage](https://www.alphavantage.co) | 股票和外汇数据 | 有 |
| [FRED](https://fred.stlouisfed.org/docs/api/api_key.html) | 美联储经济数据 | 有 |

使用免费提供商(Yahoo Finance、SEC、美联储)的模块无需任何 API 密钥即可正常工作。

#### 运行总览

| 进程 | 命令 | 端口 | 用途 |
|------|-----|------|------|
| Next.js | `npm run dev` | 3000 | 面板主程序 |
| OpenBB *(可选)* | `openbb-api --host 127.0.0.1 --port 6900` | 6900 | 市场数据 API |

---

## OpenClaw 与 Supabase
Expand Down Expand Up @@ -156,8 +110,7 @@ index.ts — 模块注册
- **shadcn/ui** + Tailwind CSS v4 + Lucide React
- **SQLite**,基于 better-sqlite3 + Drizzle ORM(本地运行,零配置)
- **OpenRouter** 提供 LLM 集成(OpenAI SDK)
- **Recharts** 用于财务数据可视化
- **[OpenBB](https://github.com/OpenBB-finance/OpenBB)** 提供市场数据(Python 侧车服务)
- **Recharts** 用于图表

## 路线图

Expand Down
39 changes: 10 additions & 29 deletions USER_MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,35 +77,19 @@ In the **local install**, your data lives in `data/dashboard.db` and `data/vault

## Finance

The Finance page has **two modes**, switchable from a tab at the top.
**What it is.** Personal finance: accounts, transactions, budgets, and manually tracked investments. Data is stored per user in Postgres (same as the rest of the app).

### Personal Finance

Works immediately, no setup required. Stored in your local database.

- **Budget view** — set monthly budgets per category and see how much you have left.
- **Transaction list** — log income and expenses; filter and search.
- **Investment portfolio** — track holdings (manually entered or imported).

### Market Intelligence 🖥 Local install only

Live market data via the optional OpenBB sidecar (see `INSTALL.md` Step 5). When OpenBB is not running, the page shows a connection banner instead of widgets. **In the hosted version this tab is hidden** — OpenBB binds to `127.0.0.1:6900` on your own machine, so it can't be reached from a serverless cloud. Run the local install if you want it.

The page is organised as a customizable grid of widgets:

- **Overview** — a summary of indices, top movers, etc.
- **Equity** — quotes, charts, screener results.
- **Crypto** — coin quotes, market caps.
- **Economy** — macro indicators, treasury rates, S&P 500 multiples, congressional trades.
- **News** — financial news feed.
- Specialty widgets: ETF, forex, derivatives, fixed income, commodities, regulators, quantitative, technical (see `components/finance/market/widgets/`).
**Core actions.**

Click the **Customize** drawer to choose which widgets appear and in what order. The **search input** at the top lets you query a specific symbol.
- **Dashboard** tab — net worth summary, cash-flow chart, expense breakdown, account list.
- **Transactions** tab — add and filter income, expenses, and transfers.
- **Budget** tab — monthly limits per category.
- **Investments** tab — holdings by symbol (manual entry).

**Tips.**

- Modules backed by Yahoo Finance, the SEC, and the Federal Reserve work without any API keys. Other providers need a free key — the widget tells you which one.
- The **Ask Claw** button on this page sends the current data context into the AI assistant so it can answer questions about what you are looking at.
- Create at least one account before adding transactions.
- Categories on transactions power the budget and expense charts.

---

Expand Down Expand Up @@ -233,25 +217,22 @@ The Claw page has a basic chat **DM panel** and a much richer **advanced view**
The settings page is divided into tabs:

- **Appearance** — light / dark / system theme, language (English / 简体中文), accent color.
- **Finance Display** — pick which currency you see, decimal precision, default time range.
- **Finance Data Providers** 🖥 Local install only — paste API keys for BizToc, Benzinga, Financial Modeling Prep, Tradier, Polygon.io, Alpha Vantage, FRED. Each row links to the provider's free signup page. The hosted version doesn't show this section because OpenBB doesn't run on Vercel.
- **OpenBB** 🖥 Local install only — host and port for your local OpenBB API (defaults to `127.0.0.1:6900`). Hidden in the hosted version.
- **Invoice** — your business name, logo, address, tax rate, currency, payment details. These pre-fill every new invoice.
- **Claw Access** 🖥 Local install only — OpenRouter API key, model selection, per-tool approval defaults. The hosted version doesn't ship a bundled LLM, so this tab is hidden — pair a lobster from the Claw page instead.
- **Data Management** — export everything to JSON, import a previous export, or wipe the database.

**Tips.**

- The dashboard never reads from a `.env` file. Everything you would normally put in environment variables lives here in Settings.
- After changing the OpenRouter key or OpenBB port, no restart is needed — the change applies immediately.
- After changing the OpenRouter key, no restart is needed — the change applies immediately.

---

## Where your data lives

All application data lives in **Supabase Postgres**, partitioned per user by `user_id` and enforced by Row-Level Security (`auth.uid() = user_id`). That includes the mind map, todos, plans, invoices, marked items, settings, finance rows, claw connections, **wiki pages** (`wiki_pages` / `wiki_log_entries`), and dashboard cards.

**Self-hosted** installs use the same stack: set `DATABASE_URL`, Supabase Auth env vars, and run the app; optional `DEPLOYMENT_MODE=local` still enables OpenBB and bundled LLM features on the machine that runs Next.
**Self-hosted** installs use the same stack: set `DATABASE_URL`, Supabase Auth env vars, and run the app; optional `DEPLOYMENT_MODE=local` still enables bundled LLM features on the machine that runs Next.

Vault secrets are encrypted in the browser (hosted-style) when `DEPLOYMENT_MODE=cloud`, or handled server-side when `DEPLOYMENT_MODE=local` — see **Vault** in the UI.

Expand Down
37 changes: 9 additions & 28 deletions USER_MANUAL.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,35 +75,19 @@

## 财务(Finance)

财务页有 **两种模式**,通过顶部 Tab 切换
**是什么。** 个人理财:账户、收支、预算,以及手动维护的投资持仓。数据与其他功能一样按用户存在数据库中

### 个人理财(Personal Finance)

无需任何配置即可使用,全部存在本机数据库。

- **预算视图** —— 按分类设置月度预算,查看剩余额度。
- **收支明细** —— 记录收入和支出,可筛选、可搜索。
- **投资组合** —— 跟踪持仓(手动录入或导入)。

### 市场情报(Market Intelligence)

通过可选的 OpenBB 后端(详见 INSTALL 第 5 步)拉取实时市场数据。OpenBB 未启动时,此页会显示一个连接横幅而不是数据卡片。

页面是一个**可定制的卡片网格**:

- **总览** —— 主要指数、涨跌榜等。
- **股票** —— 行情、走势图、筛选结果。
- **加密货币** —— 币种行情、市值。
- **宏观经济** —— 经济指标、国债收益率、标普 500 估值倍数、国会议员交易等。
- **新闻** —— 财经新闻流。
- 专业卡片:ETF、外汇、衍生品、固定收益、商品、监管、量化、技术分析(详见 `components/finance/market/widgets/`)。
**核心操作。**

点击 **Customize** 抽屉可以选择展示哪些卡片以及它们的顺序。顶部的 **搜索框** 用于查询特定标的。
- **概览** Tab —— 净资产摘要、现金流图、支出分类、账户列表。
- **交易** Tab —— 添加与筛选收入、支出、转账。
- **预算** Tab —— 按分类设置月度上限。
- **投资** Tab —— 按代码维护持仓(手动录入)。

**小贴士。**

- 由 Yahoo Finance、SEC、美联储驱动的卡片**不需要 API Key**。其他卡片缺 Key 时会自行提示需要哪个
- 页面上的 **Ask Claw** 按钮会把当前数据上下文一起送给 AI 助手,方便你针对眼前的内容追问
- 添加交易前请先创建至少一个账户
- 交易上的分类会驱动预算与支出图表

---

Expand Down Expand Up @@ -227,17 +211,14 @@ Claw 页面分为基础的 **DM 聊天面板** 和功能更全面的 **高级视
设置页分若干 Tab:

- **外观** —— 浅色/深色/跟随系统、语言(English / 简体中文)、强调色。
- **财务展示** —— 默认币种、小数精度、默认时间范围。
- **财经数据源** —— 粘贴 BizToc、Benzinga、Financial Modeling Prep、Tradier、Polygon.io、Alpha Vantage、FRED 等 Key。每行旁有免费注册链接。
- **OpenBB** —— 本地 OpenBB API 的主机和端口(默认 `127.0.0.1:6900`)。
- **发票** —— 你的公司名称、Logo、地址、税率、币种、收款方式。每张新发票会自动带上。
- **Claw 访问** —— OpenRouter API Key、模型选择、各工具的默认审批策略。
- **数据管理** —— 一键导出全部数据为 JSON、再导入回来,或者清空数据库。

**小贴士。**

- 面板**不读取 `.env` 文件**,所有原本会写在环境变量里的配置都集中在这里。
- 修改 OpenRouter Key 或 OpenBB 端口后,**无需重启**,立即生效。
- 修改 OpenRouter Key ,**无需重启**,立即生效。

---

Expand Down
Loading
Loading