https://github.com/ankaboot-source/leadminer
⛏ Leadminer - mine contacts from your own mailbox
https://github.com/ankaboot-source/leadminer
contact-management crm email-marketing email-parsing email-validation email-verification fundraising gdpr marketing osint personal-data portability sales scraper signature signature-recognition
Last synced: 3 months ago
JSON representation
⛏ Leadminer - mine contacts from your own mailbox
- Host: GitHub
- URL: https://github.com/ankaboot-source/leadminer
- Owner: ankaboot-source
- License: agpl-3.0
- Created: 2022-01-18T07:05:12.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-02-28T13:12:26.000Z (3 months ago)
- Last Synced: 2026-02-28T14:05:52.652Z (3 months ago)
- Topics: contact-management, crm, email-marketing, email-parsing, email-validation, email-verification, fundraising, gdpr, marketing, osint, personal-data, portability, sales, scraper, signature, signature-recognition
- Language: TypeScript
- Homepage: https://www.leadminer.io/
- Size: 7.36 MB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://snyk.io/test/github/ankaboot-source/leadminer?targetFile=package.json)
[](https://qlty.sh/gh/ankaboot-source/projects/leadminer)
[](https://developer.mozilla.org/en-US/observatory/analyze?host=App.leadminer.io)
[](https://app.deepsource.com/gh/ankaboot-source/leadminer/)
Leadminer
Extract, clean and enrich email addresses from your own mailbox.
## ✨ Features
- ⛏️📧 Extract contacts from your mailbox
- 🧹💌 Clean your email list
- 💎✒️ Enrich contacts with signature extraction
- 📤📇 Export to CSV, VCards or Google Contacts
- 📧🚀 Send email campaigns to your contacts using your own email with analytics
## 📑 Table of contents
- [📦 How to run locally?](#-how-to-run-locally)
- [Prerequisites](#prerequisites)
- [Clone the repository](#clone-repo)
- [Generate environment variables](#generate-env)
- [Start Supabase locally](#running-with-supabase-locally)
- [Start Redis](#start-redis)
- [Start all services](#start-services)
- [Launch the app](#launch-app)
- [Setup third-party services (optional)](#setup-third-party-services)
- [🤝 Contributing](#-contributing)
- [🎯 Roadmap](#-roadmap)
- [🛠️ Support](#️-support)
- [📜 License](#-license)
## 📦 How to run locally?
This section describes the recommended local setup only.
> Note: this project integrates with third-party services for email cleaning and enrichment. You can run locally with mocks first, then plug real providers later.
Prerequisites:
Make sure all the prerequisites are installed on your system
```
node -v
npm -v
bun -v
docker -v
docker-compose -v
```
1. Clone the repository & install dependencies:
```bash
git clone https://github.com/ankaboot-source/leadminer
cd leadminer
npm run install-deps
```
2. Generate environment variables:
Run the command below to generate pre-configured `.env` files for local development.
- The script copies `.env.dev` when available.
- If `.env.dev` is missing, it falls back to `.env.example`.
- It prepares `.env` files for `./frontend`, `./backend`, `./micro-services/emails-fetcher`, and `./supabase/functions`.
```bash
npm run dev:generate-env
```
3. Start Supabase locally:
```sh
npm run dev:supabase
```
4. Start Redis:
If you prefer to run a Redis container, use the command below. Otherwise, ensure Redis is installed on your machine and skip this step.
> Note: if you encounter issues connecting to the Redis container, update `REDIS_HOST` in your backend `.env`.
```sh
docker-compose -f docker-compose.dev.yml up -d
```
5. Start all services:
Start frontend, backend, workers, micro-service fetcher, and Supabase edge functions:
```sh
npm run dev:all
```
6. Setup third-party services (optional)
External services for email verification and LLM-based signature extraction.
- **[Reacher](https://reacher.email/):** Use the SaaS version or self-host. Refer to [Reacher's documentation](https://help.reacher.email/) for setup.
> **Note:** Refer to [./backend/.env.dev](./backend/.env.dev)
- **[MailerCheck](https://mailercheck.com):** Sign up, then update `MAILERCHECK_API_KEY` in the `.env` file.
> Refer to [./backend/.env.dev](./backend/.env.dev) for guidance.
- **[Zero bounce](https://www.zerobounce.net/):** Sign up, then update `ZEROBOUNCE_API_KEY` in the `.env` file.
> Refer to [./backend/.env.dev](./backend/.env.dev) for guidance.
- **[OpenRouter](https://openrouter.ai/):** Used for LLM-powered email signature extraction.
Add your API key as `SIGNATURE_OPENROUTER_API_KEY` in the `.env` file.
> Refer to [./backend/.env.dev](./backend/.env.dev) for guidance.
7. Launch the app:
Finally, open: http://localhost:8082/
## 🤝 Contributing
Thank you for taking the time to contribute! Please refer to our [CONTRIBUTING.md](https://github.com/ankaboot-source/leadminer/blob/main/CONTRIBUTING.md) for guidelines and more information on how to get started.
## 🎯 Roadmap
For any specific requests or suggestions regarding the roadmap, please feel free to contact [ankaboot professional services](mailto:contact@ankaboot.fr) or check the open issues for ongoing discussions and updates.
## 🛠️ Support
If you encounter any issues, please check the [issues tab](https://github.com/ankaboot-source/leadminer/issues) to see if it has already been reported and resolved. Ensure that you are using the latest version before reporting an issue. If the problem persists, feel free to [open a new issue](https://github.com/ankaboot-source/leadminer/issues/new).
Please note that this app is provided for free and without any guarantee or official support. If you require additional assistance, you can contact [ankaboot professional services](mailto:contact@ankaboot.fr) for help.
## 📜 License
This software is [dual-licensed](DUAL-LICENSE.md) under [GNU AGPL v3](LICENSE).