Briefly-AI

Table of Contents

• Description
• Inspiration
• Screenshots
• Technologies and Libraries
• Main Features
• Possible Upgrades
• How to Use
• Installation

Description

Briefly AI is a cutting-edge AI Assistant designed to streamline your communication management. Leveraging advanced AI models and APIs, Briefly AI generates concise summaries for emails and Slack messages, drafts intelligent email responses, and automates these tasks for continuous operation and convenience.

Inspiration

The inspiration for this AI Assistant came from my own struggle to keep up with the loads of emails and Slack messages I receive daily. As an undergraduate juggling classes, projects, and internships, I found myself spending way too much time trying to sift through endless threads of messages and emails. I thought, "There has to be a smarter way to handle this!"

That's when I decided to harness the power of AI to help me out. I wanted something that could give me quick summaries and draft responses so I could focus on more important things—like coding, studying, or, let's be honest, binge-watching my favorite shows. This project was born out of a need for more efficiency and a desire to see how far I could push AI to make my life easier. By the way, if you have read this far, let me tell you that this readme file was written by an LLM too.

Screenshots

Technologies and Libraries

• Frontend Technologies:
  • Angular for a sleek and responsive user interface
  • Ngx-Markdown for rendering Markdown content
• Backend Technologies:
  • Python for robust backend operations
  • Flask for a lightweight and efficient web framework
• Google Cloud APIs for seamless integration and authentication:
  • google-auth
  • google-auth-oauthlib
  • google-auth-httplib2
  • google-api-python-client
• Environment Management:
  • python-dotenv for secure credential management
• AI and Machine Learning:
  • google-generativeai for state-of-the-art language models
• Communication Platform Integration:
  • slack-sdk for Slack integration
• Containerization and Orchestration:
  • Docker for containerizing the application
  • Kubernetes for deploying and managing containers
  • Nginx for serving the frontend and proxying API requests
• Others:
  • requests for handling HTTP requests
  • flask-cors for handling cross-origin requests

Main Features

• Advanced Email Summarization: Utilizes Gemini AI to generate insightful and concise summaries of email threads using sophisticated prompt engineering techniques.
• Intelligent Slack Summarization: Produces comprehensive summaries of Slack conversations, ensuring users stay updated without reading every message.
• AI-Driven Email Response Drafting: Employs machine learning algorithms to draft contextually relevant email responses, tailored to user preferences and communication style.
• Automated and Secure Workflow: Periodically performs tasks using credentials securely stored in a .env file, ensuring data privacy and continuous operation.
• Seamless AI API Integration: Integrates with Google Generative AI APIs to harness the full potential of LLMs for natural language understanding and generation.
• User-Friendly Interface: A modern and sleek frontend built with Angular, providing an intuitive user experience.
• Multi-Platform Support: Supports both email and Slack integrations, with future plans for additional platforms.
• Real-Time Updates: Keeps you informed with real-time summaries and drafts, enhancing productivity and efficiency.

Possible Upgrades

• Add Discord Support.
• Add Whatsapp Business Support.
• Add Microsoft Teams Support.

How to Use

1. Enter your credentials: Input your Google and Slack credentials securely into form.
2. Specify the time range: Define the number of hours for which you want to generate summaries.
3. Generate Summaries: Click on the respective buttons to generate email or Slack summaries.
4. Draft Responses: Use the AI-driven drafting feature to automatically generate email responses.

Installation

Prerequisites

• Python 3.x
• Node.js and npm (for the Angular frontend)
• Docker and Docker Compose
• Minikube (for Kubernetes)
• kubectl (Kubernetes command-line tool)
• Helm (Kubernetes package manager)

Backend Setup

1. Clone the repository:

   git clone https://github.com/yourusername/briefly-ai.git
   cd briefly-ai/backend

2. Create a virtual environment and activate it:

   python -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`

3. Install the required packages:

   pip install -r requirements.txt

4. Run the backend server:

   python app.py

Frontend Setup

1. Navigate to the frontend directory:

   cd ../frontend

2. Install the required packages:

   npm install

3. Run the Angular development server:

   ng serve

Docker Setup

1. Build and run the Docker containers using Docker Compose:

   docker-compose up --build

Kubernetes Setup

1. Start Minikube:

   minikube start

2. Enable Ingress in Minikube:

   minikube addons enable ingress

3. Deploy the application using Helm:

   cd ../k8s
   helm install briefly-ai .

Accessing the Application

1. Use the following command to get the URL for accessing the frontend:

   minikube service briefly-ai-frontend

2. Open your web browser and navigate to the provided URL to access Briefly AI.