README.md

Chloe

Your intelligent email companion

An Electron application with React and TypeScript

📋 License

This software is available under two licenses:

• Open Source: GNU General Public License v3.0 (see LICENSE)
• Commercial Use: Subject to additional terms (see COMMERCIAL_AGREEMENT.md)

⚠️ Important: Commercial use including Y Combinator applications, fundraising, or building commercial products requires compliance with our commercial terms.

Features

• 📧 Gmail Integration - Seamlessly connect and manage your Gmail inbox
• 🤖 LM Studio Support - Chat with local LLMs for email assistance
• 🔄 Real-time Sync - Automatic email synchronization
• 🎯 Smart Labels - Intelligent email categorization
• 🌓 Dark/Light Mode - Comfortable viewing in any environment
• 💾 Local Storage - Your data stays on your device with Realm DB

Recommended IDE Setup

• VSCode + ESLint + Prettier

Project Setup

Install

$ npm install

Gmail Authentication

To connect your Gmail account:

$ npm run auth:gmail

This will:

1. Open your browser for Google authentication
2. Generate a refresh token for Gmail API access
3. Optionally update your .env file automatically

Development

$ npm run dev

Build

# For windows
$ npm run build:win

# For macOS
$ npm run build:mac

# For Linux
$ npm run build:linux