rag-from-scratch

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• Node.js 运行环境（README 节选未指定具体版本）
• 本地 LLM 运行能力：技术栈含 node-llama-cpp，需本地模型文件
• 无需任何云端 API Key（项目明确声明 No cloud APIs）
• 可读写本地文件系统的开发机，用于存放文档与本地向量库

安装与启动步骤

1. 1克隆项目仓库

   README 节选未给出安装命令，此处按项目 GitHub 地址执行标准克隆操作，克隆到本地目录后进入该目录查看完整说明。

   git clone https://github.com/pguso/rag-from-scratch.git
   cd rag-from-scratch

   复制

2. 2确认 Node.js 就绪

   项目以 JavaScript 编写、技术栈含 Node.js，先确认本机已安装 Node.js 及 npm，具体版本要求以仓库内的说明文件为准。

   node -v
   npm -v

   复制

3. 3安装项目依赖

   README 节选未列出依赖安装命令，Node 项目通常使用 npm 安装；请以仓库实际提供的锁文件与说明为准，不要凭猜测添加包。

   npm install

   复制

4. 4准备本地模型文件

   项目强调不依赖云端 API，通过 node-llama-cpp 在本地运行 LLM；README 节选未给出具体模型名称与放置路径，需查阅仓库内说明自行准备模型文件。

5. 5按教程顺序读代码

   README 说明学习路径为：知识需求定义、数据加载、文本切分与分块、嵌入、本地向量库、检索、重排与归一化、查询改写、上下文增强生成。按此顺序逐个运行示例理解每一步。

如何确认成功

README 节选未给出启动成功判据；以仓库内示例脚本能正常运行、并输出基于本地文档的检索与回答结果为参考。

常见问题

注意事项

• README 节选只包含项目理念与概念流程，没有安装命令、端口、路径等部署细节，实际部署请以仓库完整 README 为准。
• 本项目定位为教学教程，代码以“透明、可读懂”为目标，未必适合直接用于生产环境。
• 本地运行 LLM 对内存和显存有要求，模型文件需自行准备，README 节选未给出模型规格。
• 请勿自行添加 README 未提及的依赖包、环境变量或启动参数，以免与教程讲解不一致。