Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
265 lines (177 loc) · 6.59 KB

GETTING_STARTED.md

File metadata and controls

265 lines (177 loc) · 6.59 KB

🚀 Getting Started - One Command Setup

The fastest way to start prospecting with AI automation

🎯 Complete setup in 2-3 minutes • 🚀 First campaign in 5 minutes • 📊 Results in Notion dashboard

Created by Minhal Abdul Sami

💆‍♂️ For Complete Beginners

🎆 Magic Command - Does Everything!

python cli.py quick-start

🎉 This single command handles everything automatically:

Step What Happens Time
⚙️ Validates your configuration 10s
📊 Sets up your Notion dashboard 30s
🔍 Finds and processes 5 companies 2-3 min
🧠 Extracts prospects and contacts Included
📧 Generates personalized emails Included
📊 Updates analytics and notifications 10s

🎆 Total Time: 3-4 minutes for complete automation!

📈 For Regular Use

💪 Power User Command - Full Control

python cli.py run-campaign --limit 10 --generate-emails --send-emails

🎯 Customizable Options:

Option Purpose Example
--limit 10 Process 10 companies More prospects
--generate-emails Create personalized emails Ready to review
--send-emails Send emails immediately Full automation
--campaign-name "My Campaign" Custom campaign tracking Organization
--sender-profile profiles/my_profile.md Use specific profile Personalization

🚀 Quick Commands Reference

# Recommended for beginners
python cli.py quick-start

# Standard campaign (most common)
python cli.py run-campaign --limit 10 --generate-emails

# Full automation with sending
python cli.py run-campaign --limit 5 --generate-emails --send-emails

# Custom campaign with profile
python cli.py run-campaign --limit 10 --generate-emails --sender-profile profiles/my_profile.md --campaign-name "Weekly Outreach"

⚙️ Prerequisites & Setup

📄 Before You Start

Requirement Status Action
Python 3.13+ ❓ Download here
Dependencies ❓ pip install -r requirements.txt
API Keys ❓ Setup guide

🔑 Required API Keys

# Essential for automation (add to .env file)
NOTION_TOKEN=your_notion_token
HUNTER_API_KEY=your_hunter_api_key
OPENAI_API_KEY=your_openai_api_key

# Optional for email sending
RESEND_API_KEY=your_resend_api_key
SENDER_EMAIL=your-name@yourdomain.com
SENDER_NAME=Your Full Name

🔗 Need help getting API keys? → 🔑 Complete API Keys Guide

🎆 What Happens Automatically

🤖 The system handles everything behind the scenes:

flowchart TB
    A[📊 Creates Notion databases] --> B[🔍 Tracks progress in real-time]
    B --> C[⚡ Processes companies in parallel]
    C --> D[📱 Sends notifications when complete]
    D --> E[📈 Updates daily analytics]
    E --> F[📊 Generates comprehensive reports]
    
    style A fill:#e1f5fe
    style B fill:#f3e5f5
    style C fill:#e8f5e8
    style D fill:#fff3e0
    style E fill:#fce4ec
    style F fill:#e0f2f1
Loading

🚀 Performance Benefits

Feature Manual Process ProspectAI Improvement
Company Research 2-3 hours 3-5 minutes 20-40x faster
Team Discovery Manual clicking AI extraction Fully automated
Email Writing Generic templates AI personalized 10x better
Data Management Spreadsheets Notion dashboard Professional
Parallel Processing One-by-one 5 companies at once 5x throughput

🔧 Advanced Usage

💪 For users who want more control over the process

🔍 Click here for step-by-step commands

🔧 Individual Steps

# 1. Setup only (one-time)
python scripts/setup_dashboard.py

# 2. Discovery only (find companies)
python cli.py discover --limit 10

# 3. Email generation for specific prospects
python cli.py generate-emails --prospect-ids "id1,id2,id3"

# 4. Email generation for recent prospects (easier)
python cli.py generate-emails-recent --limit 5

# 5. Analytics update
python cli.py daily-summary

🎨 Customization Options

# Use custom sender profile
python cli.py run-campaign --sender-profile profiles/my_profile.md

# Test mode (no actual API calls)
python cli.py --dry-run run-campaign --limit 3

# Verbose output for debugging
python cli.py --verbose run-campaign --limit 5

# Custom campaign naming
python cli.py run-campaign --campaign-name "Q1 Outreach - Tech Startups"

📊 Performance Optimization

# Apply all performance fixes (recommended)
python scripts/fix_all_performance_issues.py

# Test performance improvements
python scripts/run_performance_tests.py

# Benchmark current setup
python scripts/performance_benchmark.py

💡 Pro Tip: For most users, quick-start and run-campaign are all you need!

🆘 Need Help?

🔧 Diagnostic Commands

Problem Command Purpose
⚙️ Setup Issues python cli.py validate-config Check configuration
📱 Notifications python cli.py test-notifications Test notification system
📊 Campaign Status python cli.py campaign-status View current progress
📈 Reports python cli.py analytics-report Generate performance report

🎆 After Running quick-start

📊 Check your Notion workspace for:

📊 Main Dashboard     → Overview and navigation
🎯 Campaign Runs      → Real-time campaign tracking  
📋 Processing Log     → Detailed step logs
📈 Daily Analytics    → Performance metrics
📧 Email Queue        → Generated emails for review
⚙️ System Status      → Component health monitoring

🎉 Success! The system is designed to be completely automated while giving you full visibility and control through Notion!

🔗 Next Steps: 💻 CLI Usage Guide • 📧 Email Generation • 🔧 Troubleshooting