🚀 IntelliMail - AI-Powered Email Client

A minimalistic, AI-powered email client that revolutionizes email management

🌟 Live Demo • 📖 Documentation • 🐛 Report Bug • 💡 Request Feature

🎯 Project Overview

I developed IntelliMail as a cutting-edge AI-powered email client that transforms how users interact with their email. This full-stack application combines modern web technologies with advanced AI capabilities to create an intelligent, efficient, and user-friendly email management experience.

✨ What Makes This Special

🤖 AI-Driven Intelligence - Built-in AI assistant powered by OpenAI GPT models for smart email composition, summarization, and responses

🔍 Advanced RAG Search - Sophisticated Retrieval Augmented Generation using Orama for lightning-fast, context-aware email search

📧 Universal Integration - Seamless connectivity with Gmail, Office365, and other major email providers via Aurinko API

⚡ Real-time Sync - Live email synchronization with intelligent threading and organization

💳 Premium Subscriptions - Integrated Stripe payment system for advanced features and premium tiers

🎨 Modern UI/UX - Sleek, responsive interface with dark mode support and keyboard-first navigation

🌟 Key Features

🤖 AI-Powered Capabilities

Smart Email Composition - AI-assisted writing with auto-completion and suggestions
Intelligent Summarization - Automatically generate concise summaries of long email threads
Context-Aware Responses - AI-generated reply suggestions based on email content and history
Advanced Search - Natural language search queries powered by embeddings and RAG technology

📨 Email Management

Multi-Provider Support - Gmail, Office365, and other IMAP/SMTP providers
Real-time Synchronization - Instant email updates across all devices
Smart Threading - Intelligent conversation grouping and organization
Advanced Filtering - Custom labels, categories, and automated sorting
Attachment Handling - Secure file management and preview capabilities

🔐 Security & Authentication

Clerk Integration - Secure user authentication and session management
OAuth 2.0 - Safe email provider connections without storing passwords
Data Encryption - End-to-end encryption for sensitive email data
Privacy Controls - Granular permissions and data access controls

💼 Premium Features

Subscription Management - Stripe-powered payment processing
Usage Analytics - Detailed insights into email patterns and productivity
Priority Support - Enhanced customer service for premium users
Advanced AI Models - Access to latest GPT models and features

🛠️ Tech Stack

Frontend

Next.js 14 - React framework with App Router
TypeScript - Type-safe development
Tailwind CSS - Utility-first styling
Radix UI - Accessible component primitives
Framer Motion - Smooth animations
React Query - Server state management

Backend & Database

Prisma - Type-safe database ORM
PostgreSQL - Robust relational database
tRPC - End-to-end typesafe APIs
Zod - Schema validation

AI & Search

OpenAI API - GPT models for AI capabilities
Orama - Full-text search engine
@xenova/transformers - Client-side ML models
Vector Embeddings - Semantic search capabilities

External Services

Aurinko API - Email provider integration
Clerk - Authentication and user management
Stripe - Payment processing
Vercel - Deployment and hosting

Development Tools

ESLint - Code linting
Prettier - Code formatting
Turbo - High-performance build system

🏗️ Architecture Overview

graph TB
    A[Next.js Frontend] --> B[tRPC API Layer]
    B --> C[Prisma ORM]
    C --> D[PostgreSQL Database]
    B --> E[OpenAI API]
    B --> F[Aurinko Email API]
    B --> G[Stripe API]
    B --> H[Orama Search Engine]
    A --> I[Clerk Auth]
    J[Email Providers] --> F
    K[Vector Embeddings] --> H
    E --> K

Core Components

Frontend Layer - Next.js app with server-side rendering and client-side interactions
API Layer - tRPC endpoints for type-safe client-server communication
Database Layer - Prisma ORM with PostgreSQL for data persistence
AI Layer - OpenAI integration for intelligent features
Email Integration - Aurinko API for multi-provider email access
Search Engine - Orama with vector embeddings for semantic search
Authentication - Clerk for secure user management
Payment Processing - Stripe for subscription management

📦 Installation & Setup

Prerequisites

Node.js 18.0 or higher
PostgreSQL database
Git for version control

1. Clone the Repository

git clone https://github.com/insertfahim/intellimail.git
cd intellimail

2. Install Dependencies

npm install
# or
yarn install
# or
pnpm install

3. Environment Configuration

Create a .env.local file in the root directory:

# Database
DATABASE_URL="postgresql://username:password@localhost:5432/intellimail"

# Clerk Authentication
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="pk_test_..."
CLERK_SECRET_KEY="sk_test_..."
NEXT_PUBLIC_CLERK_SIGN_IN_URL="/sign-in"
NEXT_PUBLIC_CLERK_SIGN_UP_URL="/sign-up"

# OpenAI
OPENAI_API_KEY="sk-..."

# Aurinko Email API
AURINKO_CLIENT_ID="your_aurinko_client_id"
AURINKO_CLIENT_SECRET="your_aurinko_client_secret"
AURINKO_SIGNING_SECRET="your_aurinko_signing_secret"

# Nylas
NYLAS_CLIENT_ID="your_nylas_client_id"
NYLAS_API_KEY="your_nylas_api_key"
GRAVATAR_API_KEY="your_gravatar_api_key"

# Stripe
STRIPE_SECRET_KEY="sk_test_..."
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY="pk_test_..."
STRIPE_PRICE_ID="price_..."
STRIPE_WEBHOOK_SECRET="whsec_..."

# App Configuration
NEXT_PUBLIC_URL="http://localhost:3001"

4. Database Setup

# Generate Prisma client
npx prisma generate

# Run database migrations
npx prisma db push

# (Optional) Open Prisma Studio
npx prisma studio

5. Start Development Server

npm run dev

Visit http://localhost:3001 to see the application.

🚀 Usage Examples

Basic Email Management

Sign Up/Sign In - Create an account or log in with existing credentials
Connect Email Account - Link your Gmail or Office365 account via OAuth
Browse Emails - Navigate through your inbox with threaded conversations
Use AI Features - Ask the AI assistant to help compose emails or summarize threads

AI Assistant Commands

# Email composition
"Help me write a professional email to decline a meeting"

# Email search
"Find all emails from John about the project proposal"

# Email summarization
"Summarize this email thread for me"

Keyboard Shortcuts

Cmd/Ctrl + K - Open command palette
G + I - Go to inbox
G + S - Go to sent emails
C - Compose new email
R - Reply to email
/ - Search emails

📂 Project Structure

intellimail/
├── src/
│   ├── app/                    # Next.js app directory
│   │   ├── (auth)/            # Authentication routes
│   │   ├── api/               # API routes
│   │   ├── mail/              # Main email interface
│   │   └── components/        # Shared components
│   ├── components/            # UI components
│   │   └── ui/               # Reusable UI primitives
│   ├── hooks/                # Custom React hooks
│   ├── lib/                  # Utility functions
│   │   ├── aurinko.ts        # Email API integration
│   │   ├── embeddings.ts     # AI embeddings
│   │   ├── orama.ts          # Search engine
│   │   └── stripe.ts         # Payment processing
│   ├── server/               # Server-side code
│   │   └── api/              # tRPC routers
│   └── styles/               # Global styles
├── prisma/                   # Database schema
├── public/                   # Static assets
└── package.json             # Dependencies

🌐 Deployment

Vercel Deployment (Recommended)

Connect Repository
```
vercel --prod
```
Environment Variables
- Add all environment variables in Vercel dashboard
- Update URLs to production domains
Database
- Use Vercel Postgres or external PostgreSQL provider
- Run migrations on production database

Docker Deployment

# Dockerfile included in repository
docker build -t intellimail .
docker run -p 3000:3000 intellimail

Manual Deployment

# Build the application
npm run build

# Start production server
npm run start

🧪 Development Guidelines

Code Style

TypeScript - Use strict typing throughout
ESLint - Follow configured linting rules
Prettier - Maintain consistent code formatting
Component Structure - Use functional components with hooks

Testing

# Run type checking
npm run type-check

# Run linting
npm run lint

# Format code
npm run format

Database Changes

# Create migration
npx prisma migrate dev --name migration_name

# Reset database
npx prisma migrate reset

# Deploy migrations
npx prisma migrate deploy

🤝 Contributing

I welcome contributions to make IntelliMail even better! Here's how you can help:

Getting Started

Fork the repository
Create a feature branch - git checkout -b feature/amazing-feature
Make your changes - Follow the development guidelines
Test thoroughly - Ensure everything works as expected
Commit changes - git commit -m 'Add amazing feature'
Push to branch - git push origin feature/amazing-feature
Open a Pull Request

Contribution Guidelines

📝 Clear descriptions - Explain what your changes do
🧪 Test coverage - Include tests for new features
📚 Documentation - Update docs for significant changes
🎨 Code style - Follow existing patterns and conventions
🐛 Bug reports - Include reproduction steps and environment details

Development Setup

# Install dependencies
npm install

# Start development server
npm run dev

# Run in turbo mode
npm run dev --turbo

🙏 Acknowledgments

I built IntelliMail using these excellent tools and services:

Next.js - The React framework for production
OpenAI - AI models and API
Clerk - Authentication infrastructure
Stripe - Payment processing platform
Aurinko - Email API integration
Vercel - Deployment and hosting
Radix UI - Unstyled, accessible components
Tailwind CSS - Utility-first CSS framework

📞 Contact & Support

I'd love to hear from you! Whether you have questions, feedback, or just want to connect:

Email: faahim06@gmail.com
GitHub: @insertfahim
Issues: Report a bug or request a feature

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Built with ❤️ by Fahim

If you found this project helpful, please consider giving it a ⭐️!

Name		Name	Last commit message	Last commit date
prisma		prisma
public		public
src		src
.env.example		.env.example
.eslintrc.cjs		.eslintrc.cjs
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
bun.lockb		bun.lockb
components.json		components.json
next.config.mjs		next.config.mjs
package.json		package.json
playground.ts		playground.ts
postcss.config.cjs		postcss.config.cjs
prettier.config.js		prettier.config.js
start-database.sh		start-database.sh
tailwind.config.ts		tailwind.config.ts
tsconfig.json		tsconfig.json

Latest commit

History

Folders and files

Repository files navigation