liuyu/nofx
1
0
Fork 0
mirror of https://github.com/NoFxAiOS/nofx.git synced 2026-07-16 01:06:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): add quick demo video to localized READMEs (#1486)

Browse Source 
* docs(README): add quick demo section with video link and image

* docs(README): update demo video link

* docs(i18n): add quick demo section with video link and image for multiple languages

---------

Co-authored-by: Dean <afei.wuhao@gmail.com>
This commit is contained in:
deanokk
2026-04-19 18:07:59 +08:00
committed by GitHub
parent 851f152c50
commit 1ba50bdedf
8 changed files with 170 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

152
README.md
View File

@@ -45,6 +45,20 @@ Open **http://127.0.0.1:3000**. Done.
--- ---
## Quick Demo
<p align="center">
<a href="https://drive.google.com/file/d/1frzw-HDZ3viQvLOQKsAJGc9bT0dXs68D/view">
<img src="screenshots/demo-cover.png" alt="NOFX quick demo video" width="900"/>
</a>
</p>
<p align="center">
Click the cover image to watch the demo video.
</p>
---
## How x402 Works ## How x402 Works
Traditional flow: register account → buy credits → get API key → manage quota → rotate keys. Traditional flow: register account → buy credits → get API key → manage quota → rotate keys.
@@ -59,22 +73,22 @@ No accounts. No API keys. No prepaid credits. One wallet, every model.
### Built-in x402 Providers ### Built-in x402 Providers
| Provider | Chain | Models | | Provider | Chain | Models |
|:---------|:------|:-------| | :--------------------------------------------------------------------------------------------------------------------------------- | :---- | :-------------------------------------------------------------------- |
| <img src="web/public/icons/claw402.png" width="20" height="20" style="vertical-align: middle;"/> **[Claw402](https://claw402.ai)** | Base | GPT-5.4, Claude Opus, DeepSeek, Qwen, Grok, Gemini, Kimi — 15+ models | | <img src="web/public/icons/claw402.png" width="20" height="20" style="vertical-align: middle;"/> **[Claw402](https://claw402.ai)** | Base | GPT-5.4, Claude Opus, DeepSeek, Qwen, Grok, Gemini, Kimi — 15+ models |
--- ---
## What It Does ## What It Does
| Feature | Description | | Feature | Description |
|:--------|:------------| | :------------------ | :------------------------------------------------------------------------ |
| **Multi-AI** | DeepSeek, Qwen, GPT, Claude, Gemini, Grok, Kimi, MiniMax — switch anytime | | **Multi-AI** | DeepSeek, Qwen, GPT, Claude, Gemini, Grok, Kimi, MiniMax — switch anytime |
| **Multi-Exchange** | Binance, Bybit, OKX, Bitget, KuCoin, Gate, Hyperliquid, Aster, Lighter | | **Multi-Exchange** | Binance, Bybit, OKX, Bitget, KuCoin, Gate, Hyperliquid, Aster, Lighter |
| **Strategy Studio** | Visual builder — coin sources, indicators, risk controls | | **Strategy Studio** | Visual builder — coin sources, indicators, risk controls |
| **AI Competition** | AIs compete in real-time, leaderboard ranks performance | | **AI Competition** | AIs compete in real-time, leaderboard ranks performance |
| **Telegram Agent** | Chat with your trading assistant — streaming, tool calling, memory | | **Telegram Agent** | Chat with your trading assistant — streaming, tool calling, memory |
| **Dashboard** | Live positions, P/L, AI decision logs with Chain of Thought | | **Dashboard** | Live positions, P/L, AI decision logs with Chain of Thought |
### Markets ### Markets
@@ -82,35 +96,35 @@ Crypto · US Stocks · Forex · Metals
### Exchanges (CEX) ### Exchanges (CEX)
| Exchange | Status | Register (Fee Discount) | | Exchange | Status | Register (Fee Discount) |
|:---------|:------:|:------------------------| | :-------------------------------------------------------------------------------------------------------------------- | :----: | :----------------------------------------------------------------------------------- |
| <img src="web/public/exchange-icons/binance.jpg" width="20" height="20" style="vertical-align: middle;"/> **Binance** | ✅ | [Register](https://www.binance.com/join?ref=NOFXENG) | | <img src="web/public/exchange-icons/binance.jpg" width="20" height="20" style="vertical-align: middle;"/> **Binance** | ✅ | [Register](https://www.binance.com/join?ref=NOFXENG) |
| <img src="web/public/exchange-icons/bybit.png" width="20" height="20" style="vertical-align: middle;"/> **Bybit** | ✅ | [Register](https://partner.bybit.com/b/83856) | | <img src="web/public/exchange-icons/bybit.png" width="20" height="20" style="vertical-align: middle;"/> **Bybit** | ✅ | [Register](https://partner.bybit.com/b/83856) |
| <img src="web/public/exchange-icons/okx.svg" width="20" height="20" style="vertical-align: middle;"/> **OKX** | ✅ | [Register](https://www.okx.com/join/1865360) | | <img src="web/public/exchange-icons/okx.svg" width="20" height="20" style="vertical-align: middle;"/> **OKX** | ✅ | [Register](https://www.okx.com/join/1865360) |
| <img src="web/public/exchange-icons/bitget.svg" width="20" height="20" style="vertical-align: middle;"/> **Bitget** | ✅ | [Register](https://www.bitget.com/referral/register?from=referral&clacCode=c8a43172) | | <img src="web/public/exchange-icons/bitget.svg" width="20" height="20" style="vertical-align: middle;"/> **Bitget** | ✅ | [Register](https://www.bitget.com/referral/register?from=referral&clacCode=c8a43172) |
| <img src="web/public/exchange-icons/kucoin.svg" width="20" height="20" style="vertical-align: middle;"/> **KuCoin** | ✅ | [Register](https://www.kucoin.com/r/broker/CXEV7XKK) | | <img src="web/public/exchange-icons/kucoin.svg" width="20" height="20" style="vertical-align: middle;"/> **KuCoin** | ✅ | [Register](https://www.kucoin.com/r/broker/CXEV7XKK) |
| <img src="web/public/exchange-icons/gate.svg" width="20" height="20" style="vertical-align: middle;"/> **Gate** | ✅ | [Register](https://www.gatenode.xyz/share/VQBGUAxY) | | <img src="web/public/exchange-icons/gate.svg" width="20" height="20" style="vertical-align: middle;"/> **Gate** | ✅ | [Register](https://www.gatenode.xyz/share/VQBGUAxY) |
### Exchanges (Perp-DEX) ### Exchanges (Perp-DEX)
| Exchange | Status | Register (Fee Discount) | | Exchange | Status | Register (Fee Discount) |
|:---------|:------:|:------------------------| | :---------------------------------------------------------------------------------------------------------------------------- | :----: | :------------------------------------------------------ |
| <img src="web/public/exchange-icons/hyperliquid.png" width="20" height="20" style="vertical-align: middle;"/> **Hyperliquid** | ✅ | [Register](https://app.hyperliquid.xyz/join/AITRADING) | | <img src="web/public/exchange-icons/hyperliquid.png" width="20" height="20" style="vertical-align: middle;"/> **Hyperliquid** | ✅ | [Register](https://app.hyperliquid.xyz/join/AITRADING) |
| <img src="web/public/exchange-icons/aster.svg" width="20" height="20" style="vertical-align: middle;"/> **Aster DEX** | ✅ | [Register](https://www.asterdex.com/en/referral/fdfc0e) | | <img src="web/public/exchange-icons/aster.svg" width="20" height="20" style="vertical-align: middle;"/> **Aster DEX** | ✅ | [Register](https://www.asterdex.com/en/referral/fdfc0e) |
| <img src="web/public/exchange-icons/lighter.png" width="20" height="20" style="vertical-align: middle;"/> **Lighter** | ✅ | [Register](https://app.lighter.xyz/?referral=68151432) | | <img src="web/public/exchange-icons/lighter.png" width="20" height="20" style="vertical-align: middle;"/> **Lighter** | ✅ | [Register](https://app.lighter.xyz/?referral=68151432) |
### AI Models (API Key Mode) ### AI Models (API Key Mode)
| AI Model | Status | Get API Key | | AI Model | Status | Get API Key |
|:---------|:------:|:------------| | :--------------------------------------------------------------------------------------------------------------- | :----: | :-------------------------------------------------- |
| <img src="web/public/icons/deepseek.svg" width="20" height="20" style="vertical-align: middle;"/> **DeepSeek** | ✅ | [Get API Key](https://platform.deepseek.com) | | <img src="web/public/icons/deepseek.svg" width="20" height="20" style="vertical-align: middle;"/> **DeepSeek** | ✅ | [Get API Key](https://platform.deepseek.com) |
| <img src="web/public/icons/qwen.svg" width="20" height="20" style="vertical-align: middle;"/> **Qwen** | ✅ | [Get API Key](https://dashscope.console.aliyun.com) | | <img src="web/public/icons/qwen.svg" width="20" height="20" style="vertical-align: middle;"/> **Qwen** | ✅ | [Get API Key](https://dashscope.console.aliyun.com) |
| <img src="web/public/icons/openai.svg" width="20" height="20" style="vertical-align: middle;"/> **OpenAI (GPT)** | ✅ | [Get API Key](https://platform.openai.com) | | <img src="web/public/icons/openai.svg" width="20" height="20" style="vertical-align: middle;"/> **OpenAI (GPT)** | ✅ | [Get API Key](https://platform.openai.com) |
| <img src="web/public/icons/claude.svg" width="20" height="20" style="vertical-align: middle;"/> **Claude** | ✅ | [Get API Key](https://console.anthropic.com) | | <img src="web/public/icons/claude.svg" width="20" height="20" style="vertical-align: middle;"/> **Claude** | ✅ | [Get API Key](https://console.anthropic.com) |
| <img src="web/public/icons/gemini.svg" width="20" height="20" style="vertical-align: middle;"/> **Gemini** | ✅ | [Get API Key](https://aistudio.google.com) | | <img src="web/public/icons/gemini.svg" width="20" height="20" style="vertical-align: middle;"/> **Gemini** | ✅ | [Get API Key](https://aistudio.google.com) |
| <img src="web/public/icons/grok.svg" width="20" height="20" style="vertical-align: middle;"/> **Grok** | ✅ | [Get API Key](https://console.x.ai) | | <img src="web/public/icons/grok.svg" width="20" height="20" style="vertical-align: middle;"/> **Grok** | ✅ | [Get API Key](https://console.x.ai) |
| <img src="web/public/icons/kimi.svg" width="20" height="20" style="vertical-align: middle;"/> **Kimi** | ✅ | [Get API Key](https://platform.moonshot.cn) | | <img src="web/public/icons/kimi.svg" width="20" height="20" style="vertical-align: middle;"/> **Kimi** | ✅ | [Get API Key](https://platform.moonshot.cn) |
| <img src="web/public/icons/minimax.svg" width="20" height="20" style="vertical-align: middle;"/> **MiniMax** | ✅ | [Get API Key](https://platform.minimaxi.com) | | <img src="web/public/icons/minimax.svg" width="20" height="20" style="vertical-align: middle;"/> **MiniMax** | ✅ | [Get API Key](https://platform.minimaxi.com) |
### AI Models (x402 Mode — No API Key) ### AI Models (x402 Mode — No API Key)
@@ -123,41 +137,45 @@ Crypto · US Stocks · Forex · Metals
<details> <details>
<summary><b>Config Page</b></summary> <summary><b>Config Page</b></summary>
| AI Models & Exchanges | Traders List | | AI Models & Exchanges | Traders List |
|:---:|:---:| | :----------------------------------------------------------: | :----------------------------------------------------------: |
| <img src="screenshots/config-ai-exchanges.png" width="400"/> | <img src="screenshots/config-traders-list.png" width="400"/> | | <img src="screenshots/config-ai-exchanges.png" width="400"/> | <img src="screenshots/config-traders-list.png" width="400"/> |
</details> </details>
<details> <details>
<summary><b>Dashboard</b></summary> <summary><b>Dashboard</b></summary>
| Overview | Market Chart | | Overview | Market Chart |
|:---:|:---:| | :-----------------------------------------------------: | :-------------------------------------------------------------: |
| <img src="screenshots/dashboard-page.png" width="400"/> | <img src="screenshots/dashboard-market-chart.png" width="400"/> | | <img src="screenshots/dashboard-page.png" width="400"/> | <img src="screenshots/dashboard-market-chart.png" width="400"/> |
| Trading Stats | Position History | | Trading Stats | Position History |
|:---:|:---:| | :--------------------------------------------------------------: | :-----------------------------------------------------------------: |
| <img src="screenshots/dashboard-trading-stats.png" width="400"/> | <img src="screenshots/dashboard-position-history.png" width="400"/> | | <img src="screenshots/dashboard-trading-stats.png" width="400"/> | <img src="screenshots/dashboard-position-history.png" width="400"/> |
| Positions | Trader Details | | Positions | Trader Details |
|:---:|:---:| | :----------------------------------------------------------: | :---------------------------------------------------: |
| <img src="screenshots/dashboard-positions.png" width="400"/> | <img src="screenshots/details-page.png" width="400"/> | | <img src="screenshots/dashboard-positions.png" width="400"/> | <img src="screenshots/details-page.png" width="400"/> |
</details> </details>
<details> <details>
<summary><b>Strategy Studio</b></summary> <summary><b>Strategy Studio</b></summary>
| Strategy Editor | Indicators Config | | Strategy Editor | Indicators Config |
|:---:|:---:| | :------------------------------------------------------: | :----------------------------------------------------------: |
| <img src="screenshots/strategy-studio.png" width="400"/> | <img src="screenshots/strategy-indicators.png" width="400"/> | | <img src="screenshots/strategy-studio.png" width="400"/> | <img src="screenshots/strategy-indicators.png" width="400"/> |
</details> </details>
<details> <details>
<summary><b>Competition</b></summary> <summary><b>Competition</b></summary>
| Competition Mode | | Competition Mode |
|:---:| | :-------------------------------------------------------: |
| <img src="screenshots/competition-page.png" width="400"/> | | <img src="screenshots/competition-page.png" width="400"/> |
</details> </details>
--- ---
@@ -229,12 +247,14 @@ Everything through the web UI at **http://127.0.0.1:3000**.
## Deploy to Server ## Deploy to Server
**HTTP (quick):** **HTTP (quick):**
```bash ```bash
curl -fsSL https://raw.githubusercontent.com/NoFxAiOS/nofx/main/install.sh | bash curl -fsSL https://raw.githubusercontent.com/NoFxAiOS/nofx/main/install.sh | bash
# Access via http://YOUR_IP:3000 # Access via http://YOUR_IP:3000
``` ```
**HTTPS (Cloudflare):** **HTTPS (Cloudflare):**
1. Add domain to [Cloudflare](https://dash.cloudflare.com) (free plan) 1. Add domain to [Cloudflare](https://dash.cloudflare.com) (free plan)
2. A record → your server IP (Proxied) 2. A record → your server IP (Proxied)
3. SSL/TLS → Flexible 3. SSL/TLS → Flexible
@@ -272,12 +292,12 @@ curl -fsSL https://raw.githubusercontent.com/NoFxAiOS/nofx/main/install.sh | bas
## Docs ## Docs
| | | | | |
|:--|:--| | :------------------------------------------------------ | :------------------------------------ |
| [Architecture](docs/architecture/README.md) | System design and module index | | [Architecture](docs/architecture/README.md) | System design and module index |
| [Strategy Module](docs/architecture/STRATEGY_MODULE.md) | Coin selection, AI prompts, execution | | [Strategy Module](docs/architecture/STRATEGY_MODULE.md) | Coin selection, AI prompts, execution |
| [FAQ](docs/faq/README.md) | Common questions | | [FAQ](docs/faq/README.md) | Common questions |
| [Getting Started](docs/getting-started/README.md) | Deployment guide | | [Getting Started](docs/getting-started/README.md) | Deployment guide |
--- ---
@@ -291,26 +311,26 @@ All contributions are tracked. When NOFX generates revenue, contributors receive
**[Pinned Issues](https://github.com/NoFxAiOS/nofx/issues) get the highest rewards.** **[Pinned Issues](https://github.com/NoFxAiOS/nofx/issues) get the highest rewards.**
| Contribution | Weight | | Contribution | Weight |
|:-------------|:------:| | :---------------- | :----: |
| Pinned Issue PRs | ★★★★★★ | | Pinned Issue PRs | ★★★★★★ |
| Code (Merged PRs) | ★★★★★ | | Code (Merged PRs) | ★★★★★ |
| Bug Fixes | ★★★★ | | Bug Fixes | ★★★★ |
| Feature Ideas | ★★★ | | Feature Ideas | ★★★ |
| Bug Reports | ★★ | | Bug Reports | ★★ |
| Documentation | ★★ | | Documentation | ★★ |
--- ---
## Links ## Links
| | | | | |
|:--|:--| | :-------- | :---------------------------------------------------- |
| Website | [nofxai.com](https://nofxai.com) | | Website | [nofxai.com](https://nofxai.com) |
| Dashboard | [nofxos.ai/dashboard](https://nofxos.ai/dashboard) | | Dashboard | [nofxos.ai/dashboard](https://nofxos.ai/dashboard) |
| API Docs | [nofxos.ai/api-docs](https://nofxos.ai/api-docs) | | API Docs | [nofxos.ai/api-docs](https://nofxos.ai/api-docs) |
| Telegram | [nofx_dev_community](https://t.me/nofx_dev_community) | | Telegram | [nofx_dev_community](https://t.me/nofx_dev_community) |
| Twitter | [@nofx_official](https://x.com/nofx_official) | | Twitter | [@nofx_official](https://x.com/nofx_official) |
> **Risk Warning**: AI auto-trading carries significant risks. Recommended for learning/research or small amounts only. > **Risk Warning**: AI auto-trading carries significant risks. Recommended for learning/research or small amounts only.

14
docs/i18n/ja/README.md
View File

@@ -45,6 +45,20 @@ curl -fsSL https://raw.githubusercontent.com/NoFxAiOS/nofx/main/install.sh | bas
--- ---
## クイックデモ
<p align="center">
<a href="https://drive.google.com/file/d/1frzw-HDZ3viQvLOQKsAJGc9bT0dXs68D/view">
<img src="../../../screenshots/demo-cover.png" alt="NOFX クイックデモ動画" width="900"/>
</a>
</p>
<p align="center">
カバー画像をクリックするとデモ動画を視聴できます。
</p>
---
## x402 の仕組み ## x402 の仕組み
従来のフロー：アカウント登録 → クレジット購入 → API キー取得 → クォータ管理 → キーのローテーション。 従来のフロー：アカウント登録 → クレジット購入 → API キー取得 → クォータ管理 → キーのローテーション。

14
docs/i18n/ko/README.md
View File

@@ -45,6 +45,20 @@ curl -fsSL https://raw.githubusercontent.com/NoFxAiOS/nofx/main/install.sh | bas
--- ---
## 빠른 데모
<p align="center">
<a href="https://drive.google.com/file/d/1frzw-HDZ3viQvLOQKsAJGc9bT0dXs68D/view">
<img src="../../../screenshots/demo-cover.png" alt="NOFX 빠른 데모 영상" width="900"/>
</a>
</p>
<p align="center">
커버 이미지를 클릭하면 데모 영상을 볼 수 있습니다.
</p>
---
## x402 작동 방식 ## x402 작동 방식
기존 플로우: 계정 등록 → 크레딧 구매 → API 키 받기 → 쿼터 관리 → 키 교체. 기존 플로우: 계정 등록 → 크레딧 구매 → API 키 받기 → 쿼터 관리 → 키 교체.

14
docs/i18n/ru/README.md
View File

@@ -45,6 +45,20 @@ curl -fsSL https://raw.githubusercontent.com/NoFxAiOS/nofx/main/install.sh | bas
--- ---
## Быстрое демо
<p align="center">
<a href="https://drive.google.com/file/d/1frzw-HDZ3viQvLOQKsAJGc9bT0dXs68D/view">
<img src="../../../screenshots/demo-cover.png" alt="Видео быстрого демо NOFX" width="900"/>
</a>
</p>
<p align="center">
Нажмите на изображение обложки, чтобы посмотреть демо-видео.
</p>
---
## Как работает x402 ## Как работает x402
Традиционный процесс: регистрация → покупка кредитов → получение API ключа → управление квотой → ротация ключей. Традиционный процесс: регистрация → покупка кредитов → получение API ключа → управление квотой → ротация ключей.

14
docs/i18n/uk/README.md
View File

@@ -45,6 +45,20 @@ curl -fsSL https://raw.githubusercontent.com/NoFxAiOS/nofx/main/install.sh | bas
--- ---
## Швидке демо
<p align="center">
<a href="https://drive.google.com/file/d/1frzw-HDZ3viQvLOQKsAJGc9bT0dXs68D/view">
<img src="../../../screenshots/demo-cover.png" alt="Відео швидкого демо NOFX" width="900"/>
</a>
</p>
<p align="center">
Натисніть на зображення обкладинки, щоб переглянути демо-відео.
</p>
---
## Як працює x402 ## Як працює x402
Традиційний процес: реєстрація → купівля кредитів → отримання API ключа → управління квотою → ротація ключів. Традиційний процес: реєстрація → купівля кредитів → отримання API ключа → управління квотою → ротація ключів.

14
docs/i18n/vi/README.md
View File

@@ -45,6 +45,20 @@ Mở **http://127.0.0.1:3000**. Xong.
--- ---
## Demo nhanh
<p align="center">
<a href="https://drive.google.com/file/d/1frzw-HDZ3viQvLOQKsAJGc9bT0dXs68D/view">
<img src="../../../screenshots/demo-cover.png" alt="Video demo nhanh của NOFX" width="900"/>
</a>
</p>
<p align="center">
Nhấp vào ảnh bìa để xem video demo.
</p>
---
## x402 hoạt động như thế nào ## x402 hoạt động như thế nào
Quy trình truyền thống: đăng ký tài khoản → mua credits → lấy API key → quản lý quota → xoay key. Quy trình truyền thống: đăng ký tài khoản → mua credits → lấy API key → quản lý quota → xoay key.

14
docs/i18n/zh-CN/README.md
View File

@@ -47,6 +47,20 @@ curl -fsSL https://raw.githubusercontent.com/NoFxAiOS/nofx/main/install.sh | bas
--- ---
## 快速演示
<p align="center">
<a href="https://drive.google.com/file/d/1frzw-HDZ3viQvLOQKsAJGc9bT0dXs68D/view">
<img src="../../../screenshots/demo-cover.png" alt="NOFX 快速演示视频" width="900"/>
</a>
</p>
<p align="center">
点击封面图即可观看 Demo 视频。
</p>
---
## x402 如何工作 ## x402 如何工作
传统流程：注册账号 → 购买额度 → 获取 API Key → 管理配额 → 轮换密钥。 传统流程：注册账号 → 购买额度 → 获取 API Key → 管理配额 → 轮换密钥。

BIN
screenshots/demo-cover.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.0 MiB