Firecrawl App Examples Repository

This repository contains example applications developed using Firecrawl. These examples demonstrate various implementations and use cases for Firecrawl.

Getting Started

To explore these examples:

1. Clone this repository to your local machine.
2. Navigate to the specific example directory you're interested in.
3. Follow the README instructions within each project directory for setup and running the application.

Firecrawl 应用示例快速上手指南

本指南帮助中国开发者快速运行 firecrawl-app-examples 仓库中的示例项目，探索 Firecrawl 在不同场景下的实现方案。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows (推荐 WSL2)
• Node.js：版本 >= 18.x (推荐使用 nvm 管理版本)
• 包管理器：npm, yarn 或 pnpm
• Firecrawl API Key：您需要拥有有效的 Firecrawl API 密钥（可在 firecrawl.dev 获取）

国内加速建议： 如果下载依赖较慢，建议配置国内镜像源：

• npm: npm config set registry https://registry.npmmirror.com
• yarn: yarn config set registry https://registry.npmmirror.com

安装步骤

1. 克隆仓库 将示例仓库克隆到本地机器：

   git clone https://github.com/mendableai/firecrawl-app-examples.git
   cd firecrawl-app-examples
   

2. 选择示例项目 浏览目录结构，进入您感兴趣的具体示例文件夹（例如 simple-scraper 或其他具体案例）：

   cd <example-directory-name>
   

   (请将 <example-directory-name> 替换为实际的文件夹名称)

3. 安装依赖 在项目目录下安装所需的 Node.js 依赖：

   npm install
   

   (如果您使用 yarn 或 pnpm，请相应替换为 yarn 或 pnpm install)

4. 配置环境变量 大多数示例需要配置 API 密钥。请在项目根目录创建 .env 文件（如果不存在），并填入您的密钥：

   cp .env.example .env
   

   编辑 .env 文件，确保包含：

   FIRECRAWL_API_KEY=your_actual_api_key_here
   

基本使用

完成上述配置后，即可运行示例应用。具体的启动命令可能因示例而异，请优先查阅该项目目录下的 README.md。

通用的运行命令通常如下：

npm run dev

或者

node index.js

最简单的测试示例逻辑： 如果示例代码中包含直接调用脚本，您通常会看到类似以下的输出，表示成功抓取了目标网页内容：

// 伪代码示例，展示核心调用逻辑
import { FirecrawlApp } from '@mendable/firecrawl-js';

const app = new FirecrawlApp({ apiKey: process.env.FIRECRAWL_API_KEY });

const scrapeResult = await app.scrapeUrl('https://example.com');
console.log(scrapeResult.data.markdown);

运行成功后，终端将输出抓取到的网页 Markdown 内容或结构化数据。请根据具体示例项目的文档调整目标 URL 和参数。