EchoMind

🧠 Your Personal Neural Interface to Navigate the Information Maze 🧠

EchoMind is a smart, context-aware assistant that integrates with your digital life, starting with your emails, to create a searchable and intelligent knowledge base. It helps you stay organized, find information instantly, and gain insights from your communications.

简体中文

---

✨ Key Features

• 📧 Intelligent Email Sync: Automatically syncs and processes emails from your IMAP accounts.
• 🧠 Contextual Understanding: Builds a rich context graph from your communications to surface relevant information.
• 🔍 Advanced Search: Perform semantic searches across all your synced data. Find not just keywords, but concepts and conversations.
• 🤖 AI-Powered Drafts: Generate email replies and other text with the help of AI, based on the current context.
• 📈 Insight Generation: (Coming Soon) Proactively provides summaries and insights from your data.

---

🔧 Tech Stack

Category	Technology
Backend	Go, Gin, GORM, Asynq
Frontend	Next.js, TypeScript, Tailwind CSS, Zustand
Database	PostgreSQL (with pgvector), Redis
Container	Docker
AI	OpenAI, Gemini

---

🚀 Getting Started

Follow these instructions to get EchoMind up and running on your local machine for development and testing purposes.

Prerequisites

Make sure you have the following tools installed:

• Go (version 1.22+)
• Node.js (version 18+) with pnpm
• Docker and Docker Compose
• make

Installation & Setup

1. Clone the Repository

   git clone https://github.com/your-username/echomind.git
   cd echomind

   (Note: Remember to replace your-username with the actual repository owner's username.)

2. Configure Environment Variables Copy the example configuration files and update them with your credentials (e.g., OpenAI API key, database passwords).

   cp backend/configs/config.example.yaml backend/configs/config.yaml
   cp backend/configs/logger.example.yaml backend/configs/logger.yaml

   • Edit backend/configs/config.yaml to fill in the required secrets.

3. Start Backend Services This command starts the required databases (Postgres, Redis) in Docker containers.

   make dev-db

   Then, run the database migrations:

   make db-init

   Finally, start the backend server:

   make run-be

   The backend API will be available at http://localhost:8080.

4. Start Frontend Application In a new terminal, navigate to the frontend directory, install dependencies, and start the development server.

   cd frontend
   pnpm install
   pnpm dev

   The frontend application will be accessible at http://localhost:3000.

---

🧪 Running Tests

• Backend Tests:

  make test

• Frontend Tests:

  cd frontend
  pnpm test

---

🔍 CI/CD Monitoring

EchoMind includes a powerful CI/CD monitoring tool to help you track build status, analyze failures, and get actionable insights.

For complete setup instructions, usage examples, and advanced features, see scripts/CI_README.md.

Quick Start:

# Set up alias for daily use
echo 'alias ci="./scripts/ci.sh"' >> ~/.zshrc && source ~/.zshrc

# Basic usage
ci                 # Current status
ci watch           # Watch live workflow
ci history         # View history
ci analyze         # Deep analysis
ci interactive     # Interactive menu

---

🚢 Deployment

A production-ready setup can be deployed using Docker Compose:

docker-compose -f deploy/docker-compose.prod.yml up -d

This will build and run the frontend and backend containers, along with the required database services.

---

🗺️ Roadmap & Documentation

Our development is organized into clear, feature-driven phases. Here are our most recently completed and ongoing phases:

• ✅ v1.1.1 (Enterprise Refinement): UI/UX Standardization, Network Graph Interactivity, Performance Optimizations
• ✅ v1.1.0 (Enterprise Foundation): 规约化 Vector Architecture, Enterprise-Grade Logging Framework, Multi-process Configuration Management
• ✅ v0.9.8 (Dashboard Integration Phase 2): Complete theme system, opportunity management, enhanced Dashboard API integration
• ✅ v0.9.6-7 (Dashboard Integration Phase 1): SmartFeed AI functionality, task management, basic dashboard components
• ✅ v0.9.2-4 (Neural Nexus): Context Bridge, Omni-Bar, Generative Widget Framework
• 🚧 v1.2.0+ (Next Generation): Advanced AI features, enhanced productivity tools, ecosystem integrations

For detailed architecture and product specifications, please refer to our key documents:

• 🏗️ Technical Architecture - System design, vector search, AI services, and performance optimization
• 📚 API Documentation - Complete REST API reference with OpenAPI 3.0 specification
• 📄 Unified Product & Technical Architecture - Product design and user experience
• 🗺️ Product Roadmap - Development roadmap and milestones
• 📋 Product Requirements - Product requirements document
• 🔧 Backend Configuration - Development setup and configuration guide

---

🤝 Contributing

We welcome contributions! Please read our CONTRIBUTING.md to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.

---

📄 License

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