📧 InboxIQ

InboxIQ

Your intelligent email assistant that makes email management smarter and more efficient. With advanced AI-driven features and a sleek, responsive design, InboxIQ is the ultimate SaaS solution for individuals and businesses to manage, prioritize, and organize emails seamlessly.

🌟 Key Features

• Smart Email Categorization: Classify emails into Promotions, Social, Spam, and more.
• Priority Detection: Identify high-priority emails to focus on what matters most.
• AI-Powered Summarization: Quickly read summaries of lengthy emails.
• Template Generator: Generate AI-driven email templates tailored to your needs.
• Gmail Integration: Fetch and manage emails from your Gmail account.
• Dark Mode & Theme Customization: Elegant and accessible design with dark mode.

🚀 Demo

Try InboxIQ live on our Demo Link.

📸 Screenshots

📚 Table of Contents

• Installation
• Usage
• Project Structure
• Contributing
• License
• Contact

🔧 Installation

Prerequisites

• Node.js and npm installed.
• Gmail API Credentials: Required for email fetching.
• Auth0 Credentials: Required for authentication.

Steps

1. Clone the Repository:

   git clone https://github.com/CodeWithInferno/inboxiq.git
   cd inboxiq

2. Install Dependencies:

   npm install

3. Environment Configuration:

   1. Create a .env.local file in the root directory.
   2. Add the following environment variables:

       GOOGLE_CLIENT_SECRET=""
       GOOGLE_APPLICATION_CREDENTIALS=""
       GCP_BUCKET_NAME=""
       OPENAI_API_KEY=""
       USE_OPENAI=""
       DISABLED_API=""
       GOOGLE_CLIENT_ID=""
       TOKEN_ENCRYPTION_KEY=""
   
       AUTH0_SECRET=""
       AUTH0_BASE_URL=""
       AUTH0_ISSUER_BASE_URL=""
       AUTH0_CLIENT_ID=""
       AUTH0_CLIENT_SECRET=""
   
       NODE_ENV=""
       GOOGLE_API_KEY=""
       UPSTASH_REDIS_URL=""
       UPSTASH_REDIS_TOKEN=""

4. Run the Application:

   npm run dev

   Open http://localhost:3000 to view it in the browser.

🎉 Usage

InboxIQ provides a smart and efficient way to manage emails:

• Login: Authenticate using your Google account.
• Inbox Management: View and categorize emails in sections like Inbox, Promotions, and Social.
• Compose with AI Templates: Use the AI to generate a custom email template.
• Classify and Prioritize: Easily identify priority emails and filter through categories.
• Dark Mode: Switch to dark mode for a comfortable viewing experience.

📁 Project Structure

/inboxiq 
├── /public
|   └── Assets
├── /src 
|   ├── app
|   |   ├── api
|   |   ├── components
|   |   ├── dashboard
|   |   ├── fonts
|   |   ├── settings
|   |   ├── utils
|   |   ├── layout.js
|   |   └── page.js
|   ├── lib
|   └── sanity # Not Really Used
├── /env.local 
├── /styles 
├── /utils 
├── /api  
├── .env.local 
└── README.md 

🛠️ Contributing

We welcome contributions to improve InboxIQ! Please follow these steps:

1. Fork the Repository: Click on the fork button in GitHub.

2. Clone Your Fork:

   git clone https://github.com/CodeWithInferno/inboxiq.git

   git checkout -b feature/your-feature-name

3. Make Your Changes: Add or modify files.

4. Commit Changes:

   git commit -m "Add new feature"

5. Push to GitHub

   git push origin feature/your-feature-name

6. Create a Pull Request: Go to GitHub, navigate to Pull Requests, and submit a new PR.

Code of Conduct

Please follow our Code of Conduct to maintain a respectful and inclusive environment.

Code Of Conduct

🙏 Acknowledgments

• OpenAI: Powering the AI email summarization and template generation.
• Auth0: Authentication and user management.
• Gmail API: For seamless integration with Google accounts.