ankaboot-source/leadminer

GitHub: ankaboot-source/leadminer

一款自托管邮箱联系人提取工具,能从用户自己的邮箱中挖掘、清洗和丰富联系人信息,并支持邮件营销活动。

Stars: 12 | Forks: 2

[![已知漏洞](https://snyk.io/test/github/ankaboot-source/leadminer/badge.svg?targetFile=package.json)](https://snyk.io/test/github/ankaboot-source/leadminer?targetFile=package.json) [![可维护性](https://qlty.sh/badges/a42a3f7d-f1a1-4cf3-92aa-c14c33cea8a2/maintainability.svg)](https://qlty.sh/gh/ankaboot-source/projects/leadminer) [![Mozilla Observatory 评分](https://img.shields.io/badge/Web%20Security-A%2B-2ea44f)](https://developer.mozilla.org/en-US/observatory/analyze?host=App.leadminer.io) [![DeepSource](https://app.deepsource.com/gh/ankaboot-source/leadminer.svg/?label=code+coverage&show_trend=false&token=M4B7pZCjFk2wl_EJpgQ9f-le)](https://app.deepsource.com/gh/ankaboot-source/leadminer/)
Leadminer Logo

Leadminer

Extract, clean and enrich email addresses from your own mailbox.

## ✨ 功能 - ⛏️📧 从您的邮箱中提取联系人 - 🧹💌 清理您的邮件列表 - 💎✒️ 通过签名提取丰富联系人信息 - 📤📇 导出为 CSV、VCards 或 Google Contacts - 📧🚀 使用您自己的邮箱向联系人发送带有分析功能的邮件营销活动 ## 📑 目录 - [📦 如何在本地运行?](#-how-to-run-locally) - [前置条件](#prerequisites) - [克隆仓库](#clone-repo) - [生成环境变量](#generate-env) - [本地启动 Supabase](#running-with-supabase-locally) - [启动 Redis](#start-redis) - [启动所有服务](#start-services) - [启动应用](#launch-app) - [设置第三方服务(可选)](#setup-third-party-services) - [🤝 贡献](#-contributing) - [🎯 路线图](#-roadmap) - [🛠️ 支持](#️-support) - [📜 许可证](#-license) ## 📦 如何在本地运行? 本节仅介绍推荐的本地设置。
前置条件: 请确保您的系统已安装所有前置条件
``` node -v npm -v bun -v docker -v docker-compose -v ```
1. 克隆仓库并安装依赖:
``` git clone https://github.com/ankaboot-source/leadminer cd leadminer npm run install-deps ```
2. 生成环境变量:
运行以下命令以生成用于本地开发的预配置 `.env` 文件。 - 脚本会在可用时复制 `.env.dev`。 - 如果缺少 `.env.dev`,则回退到 `.env.example`。 - 它会为 `./frontend`、`./backend`、`./micro-services/emails-fetcher` 和 `./supabase/functions` 准备 `.env` 文件。 ``` npm run dev:generate-env ``` 3. 本地启动 Supabase: ``` npm run dev:supabase ```
4. 启动 Redis: 如果您更喜欢运行 Redis 容器,请使用以下命令。否则,请确保您的机器上已安装 Redis 并跳过此步骤。 ``` docker-compose -f docker-compose.dev.yml up -d ```
5. 启动所有服务: 启动 frontend、backend、workers、micro-service fetcher 和 Supabase edge functions: ``` npm run dev:all ```
6. 设置第三方服务(可选) 用于邮件验证和基于 LLM 的签名提取的外部服务。 - **[Reacher](https://reacher.email/):** 使用 SaaS 版本或自托管。有关设置,请参阅 [Reacher 文档](https://help.reacher.email/)。 - **[MailerCheck](https://mailercheck.com):** 注册,然后在 `.env` 文件中更新 `MAILERCHECK_API_KEY`。 - **[Zero bounce](https://www.zerobounce.net/):** 注册,然后在 `.env` 文件中更新 `ZEROBOUNCE_API_KEY`。 - **[OpenRouter](https://openrouter.ai/):** 用于 LLM 驱动的邮件签名提取。 在 `.env` 文件中添加您的 API key 为 `SIGNATURE_OPENROUTER_API_KEY`。
7. 启动应用: 最后,打开:http://localhost:8082/ ## 🎯 路线图 关于路线图的任何具体请求或建议,请随时联系 [ankaboot 专业服务](mailto:contact@ankaboot.fr) 或查看开放的问题以了解正在进行的讨论和更新。 ## 🛠️ 支持 如果您遇到任何问题,请查看 [问题标签页](https://github.com/ankaboot-source/leadminer/issues) 看看是否已被报告和解决。在报告问题之前,请确保您使用的是最新版本。如果问题仍然存在,请随时[提交新问题](https://github.com/ankaboot-source/leadminer/issues/new)。 请注意,此应用免费提供,不提供任何保证或官方支持。如果您需要更多帮助,可以联系 [ankaboot 专业服务](mailto:contact@ankaboot.fr) 寻求帮助。 ## 📜 许可证 本软件根据 [GNU AGPL v3](LICENSE) 进行[双重许可](DUAL-LICENSE.md)。
标签:Google Contacts, Leadminer, MITM代理, Redis, Supabase, 代码示例, 客户关系管理, 搜索引擎查询, 数据分析, 数据清洗, 潜在客户开发, 特征增强, 签名解析, 网络调试, 联系人提取, 自动化, 自动化攻击, 请求拦截, 邮件分析, 邮件营销, 邮箱挖掘, 邮箱管理