Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions .github/workflows/docker-image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,14 @@ jobs:
which pytest
python -m pytest --maxfail=2
env:
EMAIL_ACCOUNT: ${{ secrets.TEST_EMAIL_ACCOUNT }}
GOOGLE_CLIENT_ID: ${{ secrets.TEST_GOOGLE_CLIENT_ID }}
GOOGLE_CLIENT_SECRET: ${{ secrets.TEST_GOOGLE_CLIENT_SECRET }}
MONGO_URI: ${{ secrets.TEST_MONGO_URI }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
OPENROUTER_API_KEY: ${{ secrets.OPENROUTER_API_KEY }}
DEEPSEEK_API_KEY: ${{ secrets.DEEPSEEK_API_KEY }}
GOOGLE_API_KEY: ${{ secrets.GEMINI_API_KEY }}
SUMMARIZER_PROVIDER: ${{ secrets.SUMMARIZER_PROVIDER || 'openrouter' }}
TEST_EMAIL_ACCOUNT: ${{ secrets.TEST_EMAIL_ACCOUNT }}
TEST_GOOGLE_CLIENT_ID: ${{ secrets.TEST_GOOGLE_CLIENT_ID }}
TEST_GOOGLE_CLIENT_SECRET: ${{ secrets.TEST_GOOGLE_CLIENT_SECRET }}
TEST_MONGO_URI: ${{ secrets.TEST_MONGO_URI }}
TEST_OPENAI_API_KEY: ${{ secrets.TEST_OPENAI_API_KEY }}
TEST_DEEPSEEK_API_KEY: ${{ secrets.TEST_DEEPSEEK_API_KEY }}
TEST_GOOGLE_API_KEY: ${{ secrets.TEST_GEMINI_API_KEY }}
TEST_SUMMARIZER_PROVIDER: ${{ secrets.TEST_SUMMARIZER_PROVIDER || 'openai' }}

# Add a placeholder job that will always run when tests are disabled
test-skipped:
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,28 +18,28 @@ EmailEssence is a sophisticated email management solution that leverages artific
### Feature Complete (FC) Features
- 🎨 Customizable dashboard with modular components
- 🔍 Advanced keyword analysis and topic identification
- 💻 Cross-platform desktop support via Electron
- 🔄 Incremental email fetching for large inboxes
- 🎯 Smart email prioritization
- 🛠️ Enhanced user preferences and settings

### Future Features
- 💻 Cross-platform desktop support via Electron

## Technical Stack

### Frontend
- React - Modern UI framework
- Vite - Frontend tooling and build server
- JavaScript - Core language for the frontend
- Remix - Full-stack web framework
- Electron - Desktop application framework
- JavaScript - Type-safe development

### Backend
- Python - Core backend services
- FastAPI - High-performance API framework
- MongoDB - Flexible document database
- Redis - High-performance caching
- Flexible AI provider support (OpenAI, Google, OpenRouter)
- OpenRouter - AI-powered email processing

### Infrastructure
- Express.js - Web server and middleware
- OAuth 2.0 - Secure authentication
- IMAP - Email protocol support

Expand Down
5 changes: 2 additions & 3 deletions backend/.env.example
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@ GOOGLE_CLIENT_SECRET=google_client_secret
MONGO_URI=mongodb+srv://<u>:<p>@emailsummarization.1coye.mongodb.net/?retryWrites=true&w=majority&appName=EmailSummarization

# API keys
OPEN_ROUTER_API_KEY=openrouter_api_key
#OPENAI_API_KEY=openai_api_key
OPENAI_API_KEY=openai_api_key
#DEEPSEEK_API_KEY=deepseek_api_key
#GOOGLE_API_KEY=google_api_key
GOOGLE_API_KEY=google_api_key

# Summarizer Settings
# SUMMARIZER_PROVIDER=openai
Expand Down
9 changes: 6 additions & 3 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ For local development without Docker, use one of the provided setup scripts:

#### On Windows:

```ps1
```bash
# Run the setup script to create a virtual environment and install dependencies
.\\setup.ps1
.\setup.bat
```

These scripts will:
Expand Down Expand Up @@ -134,7 +134,7 @@ For Render deployments, environment variables are configured through the Render
- `google_client_secret`
- `email_account`
- `mongo_uri`
- `openrouter_api_key`
- `openai_api_key`
- Any optional variables you wish to override

This separates your development environment configuration from your production deployment, following security best practices.
Expand All @@ -152,6 +152,9 @@ For CI/CD environments, use the CI setup scripts:
```bash
# Unix/Linux/macOS
./setup-ci.sh

# Windows
.\setup-ci.bat
```

## Troubleshooting
Expand Down
130 changes: 0 additions & 130 deletions backend/app/dependencies.py

This file was deleted.

Loading