Note: This project was previously known as WhatsSummarize. The brand rename is now landing in stages — see NAMING_RECOMMENDATIONS.md for context.
A comprehensive platform for analyzing and summarizing conversations across messaging platforms using AI-powered tools. Upload chat exports, gain insights, and get intelligent summaries of your messaging history.
"See Your Conversations Clearly" - The ConvoLens tagline embodies our mission to bring clarity and insight to your communication patterns.
ConvoLens allows users to unlock insights from their conversation history across messaging platforms. By uploading standard .txt export files, users can visualize communication patterns, activity levels, and generate AI-driven qualitative summaries.
- Name: ConvoLens
- Tagline: "See Your Conversations Clearly"
- Colors: Deep Purple (#6B46C1) + Bright Cyan (#06B6D4)
- Philosophy: Focus, clarity, and insight through the "lens" of data
- Privacy-First: Secure data handling with encryption.
- AI-Powered: Deep insights using OpenAI/Anthropic (Topics, Sentiment, Summaries).
- User-Centric: Simple upload flow and dashboard visualizations.
- Platform-Agnostic: Starting with WhatsApp, expanding to Telegram, Discord, and more.
apps/web: Next.js 15 (App Router) Frontend.apps/api: Express.js + TypeORM Backend.packages/ui: Shared UI library (Shadcn/UI based).
- Framework: Next.js 15.4
- Styling: Tailwind CSS + Shadcn/UI (Note: Migrating away from Ant Design).
- Auth: Supabase Auth (SSR).
- State: React Context + Supabase.
- Runtime: Node.js 18+
- Database: SQLite (Dev) / PostgreSQL (Prod/Supabase).
- ORM: TypeORM.
- Auth: Custom JWT (Note: Transitioning to Supabase Auth).
For a detailed analysis, see Technology Stack Assessment.
ConvoLens Brand Identity following shadcn/ui + Tailwind CSS principles.
- Primary Color: Deep Purple (
#6B46C1) - Wisdom, insight, premium - Secondary Color: Bright Cyan (
#06B6D4) - Clarity, technology, trust - Accent Color: Soft Lavender (
#C4B5FD) - Approachability, calm - Font: Inter
- Visual Style: Lens/focus metaphor, clean lines, modern gradients, dark mode support
Note: The project is currently in a hybrid state, transitioning from Ant Design to a pure Tailwind/Shadcn system with ConvoLens branding.
- Node.js 18+
- pnpm 8+ (
npm i -g pnpm) - Docker (Optional, for DB)
-
Clone:
git clone https://github.com/JustAGhosT/whats-summarize.git cd whats-summarize -
Install:
pnpm install
-
Environment Setup:
cp apps/web/.env.example apps/web/.env.local cp apps/api/.env.example apps/api/.env
-
Run Development:
pnpm dev
For deploying to Azure infrastructure:
- Prerequisites: Azure subscription and Azure CLI
- Setup Guide: See Azure Setup Guide for configuring GitHub Actions with OIDC authentication
- Infrastructure: See Infrastructure Guide for deployment instructions
- Documentation Index: Complete guide to all documentation.
- ConvoLens Brand Guide: Our new brand identity and implementation roadmap. ⭐
- Brand Color Guidelines: How to use ConvoLens colors vs WhatsApp colors. 🎨
- Program Name Analysis: Comprehensive analysis of all name options evaluated.
- Azure Setup Guide: Configure Azure credentials for GitHub Actions deployment.
- Implementation Plan: Roadmap for upcoming refactors and features.
- Technical Debt Registry: Known issues and tracking.
- Code Review Analysis: Deep dive into the codebase state.
- Architecture: System architecture overview.
- Unit/Integration:
pnpm test(Jest) - E2E/Visual:
pnpm test:ui(Playwright - Coming Soon)
We welcome contributions! Please read our Contributing Guidelines.
- Fork the repo.
- Create your feature branch (
git checkout -b feature/amazing-feature). - Commit your changes.
- Push to the branch.
- Open a Pull Request.
Distributed under the MIT License. See LICENSE for more information.