From d787ebc6495cfddfdd713b6bbdf61dee630dba1f Mon Sep 17 00:00:00 2001 From: 666ghj <670939375@qq.com> Date: Fri, 19 Dec 2025 14:16:42 +0800 Subject: [PATCH] Add English README file for MiroFish project - Introduced a new README-EN.md file to provide English documentation for the MiroFish project. - Included an overview of the project, vision, demo videos, quick start guide, and environment variable configuration. - Updated the existing README.md to link to the new English documentation. --- README-EN.md | 104 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 25 +++++++------ 2 files changed, 117 insertions(+), 12 deletions(-) create mode 100644 README-EN.md diff --git a/README-EN.md b/README-EN.md new file mode 100644 index 0000000..fd1b71b --- /dev/null +++ b/README-EN.md @@ -0,0 +1,104 @@ +
+ +MiroFish Logo + +简洁通用的群体智能引擎，预测万物 +A Simple and Universal Swarm Intelligence Engine, Predicting Anything + +[English](./README-EN.md) | [中文文档](./README.md) + +
+ +## ⚡ Overview + +**MiroFish** is a next-generation AI prediction engine powered by multi-agent technology. By extracting seed information from the real world (such as breaking news, policy drafts, or financial signals), it automatically constructs a high-fidelity parallel digital world. Within this space, thousands of intelligent agents with independent personalities, long-term memory, and behavioral logic freely interact and undergo social evolution. You can inject variables dynamically from a "God's-eye view" to precisely deduce future trajectories — **rehearse the future in a digital sandbox, and win decisions after countless simulations**. + +> You only need to: Upload seed materials (data analysis reports or interesting novel stories) and describe your prediction requirements in natural language +> MiroFish will return: A detailed prediction report and a deeply interactive high-fidelity digital world + +#### Our Vision + +MiroFish is dedicated to creating a swarm intelligence mirror that maps reality. By capturing the "collective emergence" triggered by individual interactions, we break through the limitations of traditional prediction: + +- **At the Macro Level**: We are a rehearsal laboratory for decision-makers, allowing policies and public relations to be tested at zero risk +- **At the Micro Level**: We are a creative sandbox for individual users — whether deducing novel endings or exploring imaginative scenarios, everything can be fun, playful, and accessible + +From serious predictions to playful simulations, we let every "what if" see its outcome, making it possible to predict anything. + +## 🎬 Demo Videos - Coming Soon + +1. Complete demo video for prediction based on BettaFish-generated public opinion report +2. Complete demo video for "Dream of the Red Chamber" ending prediction +3. Complete demo video for financial prediction + +## 🚀 Quick Start + +### Prerequisites + +| Tool | Version | Description | Check Installation | +|------|---------|-------------|-------------------| +| **Node.js** | 18+ | Frontend runtime, includes npm | `node -v` | +| **Python** | 3.11+ | Backend runtime | `python --version` | +| **uv** | Latest | Python package manager (pip alternative) | `uv --version` | + +### 1. Configure Environment Variables + +```bash +# Copy the example configuration file +cp .env.example .env + +# Edit the .env file and fill in the required API keys +``` + +**Required Environment Variables:** + +```env +# LLM API Configuration (supports any LLM with OpenAI SDK format) +# Recommended: Alibaba Qwen-plus model via DashScope: https://dashscope.aliyun.com/ +LLM_API_KEY=your_api_key +LLM_BASE_URL=https://dashscope.aliyuncs.com/compatible-mode/v1 +LLM_MODEL_NAME=qwen-plus + +# Zep Cloud Configuration +# Free monthly quota is sufficient for usage: https://app.getzep.com/ +ZEP_API_KEY=your_zep_api_key +``` + +### 2. Install Dependencies + +```bash +# One-click installation of all dependencies (root + frontend + backend) +npm run setup:all +``` + +Or install step by step: + +```bash +# Install Node dependencies (root + frontend) +npm run setup + +# Install Python dependencies (auto-creates virtual environment) +npm run setup:backend +``` + +### 3. Start Services + +```bash +# Start both frontend and backend (run from project root) +npm run dev +``` + +**Service URLs:** +- Frontend: `http://localhost:3000` +- Backend API: `http://localhost:5001` + +**Start Individually:** + +```bash +npm run backend # Start backend only +npm run frontend # Start frontend only +``` + +## 📄 License + +This project is licensed under the [Apache-2.0 License](./LICENSE). diff --git a/README.md b/README.md index 9c02efb..b1bfe7d 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,20 @@ -

- MiroFish Logo -

+
-

- 简洁通用的群体智能引擎，预测万物 -
- A Simple and Universal Swarm Intelligence Engine, Predicting Anything -

+MiroFish Logo + +简洁通用的群体智能引擎，预测万物 +A Simple and Universal Swarm Intelligence Engine, Predicting Anything + +[English](./README-EN.md) | [中文文档](./README.md) + +
## ⚡ 项目概述 **MiroFish** 是一款基于多智能体技术的新一代 AI 预测引擎。通过提取现实世界的种子信息（如突发新闻、政策草案、金融信号），自动构建出高保真的平行数字世界。在此空间内，成千上万个具备独立人格、长期记忆与行为逻辑的智能体进行自由交互与社会演化。你可透过「上帝视角」动态注入变量，精准推演未来走向——**让未来在数字沙盘中预演，助决策在百战模拟后胜出**。 -> 你只需：上传一份或多份「种子材料」（舆情分析报告、量化分析报告，甚至有趣的小说故事），并用自然语言描述你的模拟/预测需求 -> MiroFish 将返回：一份详尽的模拟/预测报告，以及一个可深度交互、可按你意愿持续推演的高保真数字世界 +> 你只需：上传种子材料（数据分析报告或者有趣的小说故事），并用自然语言描述预测需求 +> MiroFish 将返回：一份详尽的预测报告，以及一个可深度交互的高保真数字世界 #### 我们的愿景 @@ -22,7 +23,7 @@ MiroFish 致力于打造映射现实的群体智能镜像，通过捕捉个体 - **于宏观**：我们是决策者的预演实验室，让政策与公关在零风险中试错 - **于微观**：我们是个人用户的创意沙盘，无论是推演小说结局还是探索脑洞，皆可有趣、好玩、触手可及 -从严肃预测到趣味仿真，我们让每一个「如果」都能看见结果，让**预测万物**成为可能。 +从严肃预测到趣味仿真，我们让每一个如果都能看见结果，让预测万物成为可能。 ## 🎬 演示视频-待上传 @@ -53,7 +54,7 @@ cp .env.example .env ```env # LLM API配置（支持 OpenAI SDK 格式的任意 LLM） -# 推荐使用阿里百炼平台Qwen-plus模型：https://bailian.console.aliyun.com/ +# 推荐使用阿里百炼平台qwen-plus模型：https://bailian.console.aliyun.com/ LLM_API_KEY=your_api_key LLM_BASE_URL=https://dashscope.aliyuncs.com/compatible-mode/v1 LLM_MODEL_NAME=qwen-plus