This guide will walk you through installing, configuring, and using ECom Intel to analyze product reviews.

Before you begin, ensure you have:

• Python 3.8+ installed
• pip (Python package manager)
• API keys for OpenAI and Firecrawl

git clone https://github.com/kingabzpro/ECom-Intel.git
cd ECom-Intel

pip install -r requirements.txt

The following packages will be installed:

cp .env.example .env

Edit the .env file and add your API keys:

# OpenAI API Key
OPENAI_API_KEY=sk-your-openai-key-here

# Firecrawl API Key
FIRECRAWL_API_KEY=fc-your-firecrawl-key-here

# Database path (optional, defaults to reviews.db)
DATABASE_PATH=reviews.db

1. Visit platform.openai.com/api-keys
2. Sign in or create an account
3. Click "Create new secret key"
4. Copy the key and add it to your .env file

Note: ECom Intel uses the gpt-4o-mini model, which is cost-effective and fast.

1. Visit firecrawl.dev
2. Sign up for an account
3. Navigate to API settings
4. Copy your API key and add it to your .env file

streamlit run app.py

The application will start and open in your default browser at http://localhost:8501.

1. Enter a Product URL in the sidebar

   • Supported formats: Amazon, eBay, or other e-commerce product pages

2. Adjust Settings (optional)

   • Max review pages: Slider to control how many pages to scrape (1-10)
   • Use cached results: Toggle to use previously stored results

3. Click "Analyze Reviews" and watch the progress:

   • 🔍 Searching for reviews...
   • 📥 Scraping review content...
   • 🧠 Analyzing reviews with AI...
   • 💾 Saving results...

4. View Results:

   • Key metrics (total reviews, average rating, sentiment percentages)
   • Sentiment distribution pie chart
   • Rating distribution bar chart
   • Key insights and recommendations
   • Pros and cons summary
   • Sample reviews with sentiment labels

• ✅ Ensure .env file exists in the project root
• ✅ Verify API keys are correctly formatted
• ✅ Check that API keys are active and valid

• ✅ Try a different product URL
• ✅ Verify the product has reviews available
• ✅ Increase the max pages setting in the sidebar

• ✅ Verify Firecrawl API key is valid
• ✅ Check your internet connection
• ✅ Some websites may block scraping attempts

• ✅ Verify OpenAI API key and available credits
• ✅ Check if the gpt-4o-mini model is accessible
• ✅ Try again with fewer reviews (reduce max pages)

• Sentiment Distribution: Pie chart showing positive/negative/neutral breakdown
• Rating Distribution: Bar chart showing 1-5 star distribution

• Key Insights: AI-generated observations about the product
• What Customers Love: Most praised features (Pros)
• Common Complaints: Frequent issues mentioned (Cons)
• Recommendations: Actionable suggestions based on reviews

View history of previously analyzed products with their ratings and review counts.

Contributions are welcome! To contribute:

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Next: Architecture-and-Tools - Learn about the technical architecture