Supercharge your email productivity

Warning

🚧 Work in Progress 🚧

This project is still in its early stages, it's rough around the edges.

We're building in public because that's the best way to make something great. Each bug report shows us what to fix. Each issue points to what matters.

If you like seeing ideas grow from raw to remarkable, stick around. Your feedback shapes what this becomes.

Installation

Tech Stack

Dash AI is built with modern and reliable technologies:

• Frontend: Svelte, TypeScript, TailwindCSS, Shadcn UI, Skeleton UI
• Backend: Python, FastAPI, SQLAlchemy ORM, Celery
• Database: PostgreSQL with pgvector extension, Redis
• AI: OpenAI, XAI
• Authentication: Google OAuth

Getting Started

Prerequisites

Before running the application, you'll need to set up several services and environment variables:

1. Setup Local Services with Dev Container and Docker

   • Make sure you have Docker, NodeJS, and npm installed.

   • Open codebase as a container in VSCode or your favorite VSCode fork using Cmd + Shift + P

   • Run the backend using the following command

     ./run_dev.sh
     

2. Google OAuth Setup

   • Go to Google Cloud Console

   • Create a new project

   • Add the following APIs in your Google Cloud Project: People API, Gmail API

     • Use the links above and click 'Enable' or
     • Go to 'APIs and Services' > 'Enable APIs and Services' > Search for 'Google People API' and click 'Enable'
     • Go to 'APIs and Services' > 'Enable APIs and Services' > Search for 'Gmail API' and click 'Enable'

   • Enable the Google OAuth2 API

   • Create OAuth 2.0 credentials (Web application type)

   • Add authorized redirect URIs:

     • Development:
       • http://localhost:8080/oauth_callback
     • Production:
       • https://your-production-url/oauth_callback

   • Add to .env:

        POSTGRES_URL=
        SECRET_KEY=
        GOOGLE_REDIRECT_URI=
        GOOGLE_CLIENT_CONFIG=
        CELERY_BROKER_URL=
        CELERY_RESULT_BACKEND=
        STAGE=
        XAI_API_KEY=
        OPENAI_API_KEY=

   • Add yourself as a test user:

     • Go to Audience
     • Under 'Test users' click 'Add Users'
     • Add your email and click 'Save'

Warning

The GOOGLE_REDIRECT_URI must match exactly what you configure in the Google Cloud Console, including the protocol (http/https), domain, and path - these are provided above.

Environment Variables

Copy .env.example to .env and configure the following variables:

POSTGRES_URL=         # Connection string for the PostgreSQL database (e.g., "postgresql://user:pass@host:port/db").
SECRET_KEY=           # Secret key for cryptographic operations and session management.
GOOGLE_REDIRECT_URI=  # URL where Google redirects after successful OAuth authentication.
GOOGLE_CLIENT_CONFIG= # JSON configuration detailing Google OAuth client credentials.
CELERY_BROKER_URL=    # URL for the Celery broker used to manage task queues.
CELERY_RESULT_BACKEND= # URL for storing the results of Celery tasks.
STAGE=                # Environment stage indicator (e.g., dev, staging, production).
XAI_API_KEY=          # API key for accessing the XAI services.
OPENAI_API_KEY=       # API key for interacting with OpenAI's services.

Update the PostgreSQL database accordingly

Alembic will apply the schema migrations set in .env

alembic upgrade head

Running Locally

Run the development server:

    ./run_dev.sh