FictionLab-你的人工智能写作实验室
一个专业的桌面应用程序，可以设置和管理具有高级上下文管理功能的AI驱动的写作工作区。无需终端命令-只需下载、安装并开始使用AI编写！
这是什么？
FictionLab是一个安装程序和管理工具，可以设置您使用AI驱动的书写系统所需的一切，包括Typing Mind或Claude Desktop等客户端。它通过易于使用的图形界面自动处理所有技术设置。
非常适合： 作家、研究人员、学生、专业人士，或任何想在不处理技术配置的情况下使用人工智能写作工具的人。
主要优势： 你不需要任何编程知识、终端经验或技术专长。只需下载安装程序并单击安装向导即可！
______________________________________________________________________
面向最终用户
下载并安装
在哪里下载
从下载适用于您的操作系统的最新安装程序 页面：
- 窗户：
FictionLab-Setup.exe（Windows 10/11，64位） - macOS：
FictionLab.dmg（macOS 10.15+、英特尔和苹果Silicon） - Linux：
FictionLab.AppImage或fictionlab.deb（Ubuntu 20.04+、Debian、其他发行版）
安装步骤
窗户：
- 下载
FictionLab-Setup.exe - 双击安装程序
- 按照安装向导进行操作（如果需要，请选择安装文件夹）
- 点击“安装”并等待完成
- 从“开始”菜单或“桌面”快捷方式启动应用程序
macOS：
- 下载
FictionLab.dmg - 打开下载的DMG文件
- 将FictionLab图标拖动到“应用程序”文件夹
- 从应用程序打开（您可能需要在安全和隐私设置中允许该应用程序）
Linux：
- 下载
FictionLab.AppImage或fictionlab.deb - 对于AppImage：使其可执行(
chmod +x FictionLab.AppImage)并运行它 - For.deb：安装时使用
sudo dpkg -i fictionlab.deb - 从应用程序菜单启动
应用程序为您做了什么
FictionLab自动设置和管理：
- PostgreSQL数据库 -存储您的写作数据和上下文
- 上下文服务器 -支持AI集成和上下文管理
- Docker容器 -运行数据库和服务器（自动管理）
- AI客户端集成 -与您选择的AI接口连接
所有这些都是通过应用程序的图形界面完成的——没有要编辑的配置文件，也没有要键入的终端命令！
所得
PostgreSQL数据库
- 自动配置并启动
- 安全密码生成
- 无需手动设置
- 在Docker中运行（由应用程序管理）
上下文服务器
- 预配置并随时可用
- 自动启动和健康监测
- 从应用程序轻松启动/停止控制
AI客户端的选择
选项1：打字思维（建议初学者使用）
- 基于Web的界面（在浏览器中运行）
- 应用程序自动下载和设置
- 无需额外安装
- 安装后立即开始使用
选项2：克劳德桌面
- 本机桌面应用程序
- 根据应用程序的指导说明进行手动安装
- 需要从Anthropic单独下载
- 该应用程序可帮助您正确配置它
你可以两者都用！ 如果你想尝试不同的界面，该应用程序支持设置多个客户端。
特性
- 一键安装 -下载并运行安装程序，就是这样！
- Docker桌面指南 -如果未安装Docker，则使用分步向导
- 自动环境设置 -没有要手动编辑的.env文件
- 打字思维下载 -自动下载并配置Typing Mind
- 系统健康监测 -仪表板显示所有组件的状态
- 轻松启动/停止控制 -使用简单按钮管理服务
- 更新通知 -更新可用时收到通知
- 交叉平台的 -适用于Windows、macOS和Linux
系统要求
最低要求：
- 操作系统： Windows 10/11（64位）、macOS 10.15+或Linux（Ubuntu 20.04+）
- 猛撞： 最低4GB（建议8GB）
- 磁盘空间： 10GB可用空间（用于Docker镜像和数据库）
- 互联网： 初始设置和下载组件所需
所需软件（应用程序将帮助您安装）：
- Docker 桌面版 -如果你没有，该应用程序将指导你完成安装
- Git -用于下载Typing Mind（如果需要，应用程序将帮助您安装）
注： 你不需要安装Node.js、npm或任何开发工具。这是一个完整的独立应用程序！
入门指南
- 下载 操作系统的安装程序（请参阅上面的“下载和安装”部分）
- 运行安装程序 并按照安装向导进行操作
- 启动应用程序 -它将出现在您的开始菜单（Windows）、应用程序文件夹（macOS）或应用程序菜单（Linux）中
- 首次安装向导 -该应用程序将指导您完成：
- 检查Docker桌面（并在需要时帮助您安装） - 检查Git（并在需要时帮助您安装） - 配置数据库设置（自动，只需查看并接受） - 选择你的AI客户端（打字思维、克劳德桌面或两者兼而有之） - 下载并设置您选择的客户端
- 开始使用！ -设置完成后：
- 点击“启动服务”启动FictionLab - 打开你的AI客户端（打字思维或克劳德桌面） - 在AI的帮助下开始写作
首次常见问题
Q： 我需要知道如何编码吗？ A： 不！此应用程序专为非技术用户设计。一切都是通过按钮和表单完成的。
Q： 我需要安装Node.js还是npm？ A： 不！这些仅适用于希望从源代码构建应用程序的开发人员。普通用户只需下载并运行安装程序。
Q： 如果我没有Docker桌面怎么办？ A： 该应用程序将检测到这一点，并向您展示安装Docker Desktop的分步指南。只需按照屏幕上的说明进行操作。
Q： 这要花多少钱？ A： FictionLab是免费和开源的。但是，您可能需要：
- Docker桌面（个人免费使用；Docker Hub帐户是可选的）
- 人工智能服务（Claude、ChatGPT等）的API信用取决于您选择的客户
Q： 我可以稍后卸载它吗？ A： 是的！只需像其他应用程序一样卸载即可。您的数据是单独存储的，不会被删除。
______________________________________________________________________
屏幕截图和功能概述
设置向导
首次设置向导将指导您完成每一步，从检查先决条件到选择AI客户端。
系统仪表盘
一目了然地监控您的书写系统的健康状况：
- PostgreSQL数据库状态
- 上下文服务器状态
- Docker容器健康状况
- 快速启动/停止控制
客户选择
在Typing Mind（自动设置）或Claude Desktop（引导手动设置）之间进行选择，或安装两者以尝试不同的界面。
Docker安装指南
如果未安装Docker Desktop，该应用程序将提供一个全面的分步向导，其中包含下载链接和安装说明。
______________________________________________________________________
支持与帮助
文档
对于最终用户：
对于开发者：
其他资源：
- 视频教程脚本 -教程视频制作指南
- 应用内帮助： 菜单：帮助→ 用户指南、故障排除、常见问题解答
获取帮助
如果您遇到问题：
- 检查应用程序日志
- 窗户： %USERPROFILE%\AppData\Roaming\fictionlab\logs - macOS： ~/Library/Logs/fictionlab - Linux： ~/.config/fictionlab/logs
- 审查先决条件
- 确保Docker Desktop已安装并正在运行 - 确保您至少有10GB的可用磁盘空间 - 检查您的防病毒软件是否没有阻止该应用程序
- 提交问题
- 访问我们的 页 - 点击“新问题” - 描述您的问题并包括相关日志文件 - 我们会帮你解决的！
常见问题
应用程序显示“Docker未运行”-我该怎么办？
- 从应用程序手动打开Docker桌面
- 等待它完全启动（Docker图标应该是稳定的，而不是旋转的）
- 在FictionLab中单击“再次检查”
打字思维无法下载-为什么？
- 确保Git已安装（该应用程序可以指导您完成此操作）
- 检查您的互联网连接
- 验证您在安装目录中是否具有写入权限
我可以将安装移动到其他文件夹吗？
- 对！卸载应用程序，然后重新安装并选择其他位置
- 您的数据和配置可以备份和恢复
安装后，这可以脱机工作吗？
- FictionLab可以脱机运行
- 然而，人工智能客户端需要互联网与人工智能服务（Claude、ChatGPT等）进行通信
______________________________________________________________________
面向开发者
以下部分仅适用于想要构建、修改或为FictionLab本身做出贡献的开发人员。普通用户不需要阅读本节。
______________________________________________________________________
开发设置
如果你想从源代码构建应用程序或为开发做出贡献：
发展的先决条件
- Node.js 18.x或更高
- npm 9.x或更高
- Git 用于版本控制
平台特定开发要求
窗户：
- 无需额外开发
macOS：
- Xcode命令行工具：
xcode-select --install
Linux：
- 构建工具：
sudo apt-get install build-essential
克隆和设置
# Clone the repository
git clone
cd MCP-Electron-App
# Install dependencies
npm install
# Build TypeScript code
npm run build开发命令
# Run in development mode with DevTools
npm run dev
# Compile TypeScript
npm run build
# Watch mode (auto-compile on changes)
npm run build:watch
# Run the compiled app
npm start
# Clean build artifacts
npm run clean生产大楼
为当前平台构建
npm run package为特定平台构建
# Windows (NSIS installer)
npm run package:win
# macOS (DMG)
npm run package:mac
# Linux (AppImage and deb)
npm run package:linux
# All platforms
npm run package:all构建输出
内置应用程序放置在 out/ 目录：
- 窗户：
out/FictionLab Setup.exe - macOS：
out/FictionLab.dmg - Linux：
out/FictionLab.AppImage,out/fictionlab.deb
项目结构
FictionLab/
├── config/ # Configuration files
│ └── setup-config.json # Build automation setup configuration
├── src/
│ ├── main/ # Main process (Node.js environment)
│ │ └── index.ts # Main process entry point
│ ├── renderer/ # Renderer process (Browser environment)
│ │ ├── index.html # Main HTML file
│ │ └── renderer.ts # Renderer process script
│ ├── preload/ # Preload scripts (IPC bridge)
│ │ └── preload.ts # Secure IPC bridge
│ ├── types/ # TypeScript type definitions
│ │ └── setup-config.ts # Configuration schema interfaces
│ └── utils/ # Utility modules
│ └── config-validator.ts # Configuration validation
├── resources/ # Static assets and build resources
├── dist/ # Compiled TypeScript output (gitignored)
├── out/ # Built application packages (gitignored)
├── docs/ # Developer documentation
├── package.json # Project dependencies and scripts
├── tsconfig.json # TypeScript configuration
└── README.md # This file设置配置
应用程序使用中定义的配置系统 config/setup-config.json 管理构建自动化和存储库管理。
配置架构
设置配置定义了：
- 仓库 -要克隆和管理的git存储库列表
- 存储库URL、本地克隆路径、分支/版本 - 非必要存储库的可选标志 - 描述和元数据
- 构建订单 -存储库构建顺序
- 要构建的存储库的有序列表 - 存储库之间的依赖关系 - 并行构建支持配置
- 构建步骤 -单个构建命令
- 每个存储库的自定义shell命令 - 工作目录和环境变量 - 错误处理和超时配置
- Docker镜像 -Docker镜像命名和构建配置
- 存储库到图像映射 - 标签命名约定 - Dockerfile路径配置
- 组件 -功能标志和可选组件
- 组件启用切换 - 按功能对存储库进行分组 - UI演示说明
配置文件
config/setup-config.json-包含所有设置参数的主配置文件src/types/setup-config.ts-定义配置模式的TypeScript接口src/utils/config-validator.ts-配置验证和加载实用程序
使用配置
要在代码中加载和验证设置配置，请执行以下操作：
import { validateSetupConfig, loadAndValidateConfig } from './src/utils/config-validator';
import { SetupConfig } from './src/types/setup-config';
// Option 1: Load from file and validate
const { config, validation } = loadAndValidateConfig('./config/setup-config.json');
if (validation.valid) {
const setupConfig: SetupConfig = config!;
// Use the configuration
} else {
console.error('Configuration errors:', validation.errors);
console.warn('Configuration warnings:', validation.warnings);
}
// Option 2: Validate a configuration object
const result = validateSetupConfig(configObject);
if (result.valid) {
// Configuration is valid
} else {
// Handle validation errors
}配置示例
看 config/setup-config.json 完整的示例配置包括：
- 多个存储库定义
- 使用依赖关系构建订单
- 每个存储库的自定义构建步骤
- Docker镜像配置
- 可选组件标志
建筑
主要工艺流程(src/main/)
- 应用程序入口点，在Node.js环境中运行
- 创建和管理应用程序窗口
- 处理系统级操作（Docker检查、文件操作）
- 管理IPC与渲染器进程的通信
- 控制应用程序生命周期
渲染器进程(src/renderer/)
- 在Chromium浏览器环境中运行
- 呈现用户界面（设置向导、仪表板等）
- 处理用户交互
- 通过IPC与主进程通信
- 沙盒安全
预加载脚本(src/preload/)
- 主进程和渲染器进程之间的安全桥梁
- 使用向渲染器公开有限的API
contextBridge - 阻止渲染器直接访问Node.js API
- 遵循电子安全最佳实践
安全
此应用程序遵循电子安全最佳实践：
- 上下文隔离： 启用以分离预加载和渲染器上下文
- 节点集成： 在渲染器进程中禁用
- 沙箱： 已为渲染器进程启用
- 内容安全策略： 为防止XSS攻击而实施
- 安全IPC： 所有通信都通过预加载脚本进行
CI/CD及其发布
持续集成
每一次推动 main 或 develop 分支和所有拉取请求都会触发Windows、macOS和Linux上的自动构建。
CI管道：
- 安装依赖项
- 构建TypeScript
- 为每个平台打包Electron应用程序
- 生成SHA256校验和
- 上传构建工件（保留7天）
创建发布
- 更新中的版本
package.json - 承诺：
git commit -am "Bump version to X.X.X" - 创建标签：
git tag -a vX.X.X -m "Release version X.X.X" - 推送标签：
git push origin vX.X.X
发布工作流将自动：
- 为所有平台构建
- 生成校验和
- 创建GitHub版本
- 上传所有安装程序和校验和
看 发布.md 了解详细的发布说明。
贡献
我们欢迎捐款！以下是如何开始：
- 分叉存储库
- 创建要素分支：
git checkout -b feature/my-feature - 进行更改并彻底测试
- 提交您的更改：
git commit -am 'Add new feature' - 推到分支：
git push origin feature/my-feature - 提交拉取请求
贡献指南：
- 遵循现有代码样式
- 为新功能添加测试
- 根据需要更新文档
- 确保构建在所有平台上通过
- 遵循Electron安全最佳实践
开发者文档
完整的开发人员文档可在 docs/ 目录：
核心文件：
实施细节：
- ELECTRON-APP-REQUIREMENTS.md -技术要求
- 电子束检查表.md -捆绑检查表
- 电子部署.md -部署详细信息
- 医生图像发布.md -Docker镜像绑定
- -问题模板
看 贡献.md 获取完整的开发设置说明。
解决开发问题
TypeScript编译错误：
- 确保安装了所有依赖项：
npm install - 检查
tsconfig.json配置 - 清除构建工件：
npm run clean然后npm run build
在macOS上构建失败：
- 安装Xcode命令行工具：
xcode-select --install - 确保您拥有正确的代码签名证书（用于分发版本）
电子无法启动：
- 确保你已经构建了TypeScript：
npm run build - 检查控制台输出是否有错误
- 尝试清洁和重建：
npm run clean && npm run build
开发者资源
- 电子文档
- TypeScript手册
- 电子生成器
- 电子安全
- -CI/CD配置
______________________________________________________________________
许可证
MIT许可证-有关详细信息，请参阅许可证文件。
______________________________________________________________________
版本历史记录
0.1.0（当前）
- 初始版本
- 基本安装程序功能
- Docker桌面检测和安装指南
- PostgreSQL设置和管理
- MCP服务器集成
- 打字思维自动下载
- Claude桌面配置支持
- 跨平台支持（Windows、macOS、Linux）
- 首次安装向导
- 系统健康监控仪表板
______________________________________________________________________
记得： 如果你是最终用户，你只需要从发布页面下载安装程序并运行它。上面所有的开发设置、npm命令和技术细节都只适用于想要修改应用程序本身的开发人员！