inbox zero

Bandeja de entrada cero

Aplicación de correo electrónico de código abierto para llegar rápidamente a la bandeja de entrada cero.
Sitio web · Discord · Problemas · Kanban

Acerca de

Inbox Zero es una aplicación de correo electrónico de código abierto cuyo objetivo es ayudarlo a llegar rápidamente a la bandeja de entrada cero con asistencia de IA.

Vídeo de demostración

Características clave

• Limpiador de boletines: administre y cancele fácilmente la suscripción a los boletines.
• Asistente de IA: responda, archive, etiquete y reenvíe automáticamente correos electrónicos según reglas de mensajes de texto sin formato.
• Bloqueador de correo electrónico frío: bloquea automáticamente los correos electrónicos fríos.
• Análisis de correo electrónico: realice un seguimiento de su actividad de correo electrónico con estadísticas diarias, semanales y mensuales.
• Nuevos remitentes: identifique y bloquee nuevos remitentes de spam.
• Correos electrónicos no respondidos: realice un seguimiento de los correos electrónicos que esperan respuestas.
• Buscador de correo electrónico grande: libere espacio localizando y eliminando correos electrónicos grandes.

Construido con

• Siguiente.js
• CSS de viento de cola
• shadcn/ui
• prisma
• pajarito
• Upstash
• Turbo

Solicitudes de funciones

Para solicitar una función, abra una edición de GitHub. Si no tiene una cuenta de GitHub, puede solicitar funciones aquí. O únete a nuestro Discord.

Introducción para desarrolladores

Contribuyendo al proyecto

Tenemos un Kanban público disponible aquí. Únase a nuestro Discord para discutir tareas y comprobar en qué se está trabajando.

Requisitos

• Nodo.js >= 18.0.0
• pnpm >= 8.6.12
• Escritorio Docker (opcional)

Configuración

Aquí hay un vídeo sobre cómo configurar el proyecto. Cubre los mismos pasos mencionados en este documento. Pero entra en mayor detalle sobre la configuración de los servicios externos.

Los servicios externos que se requieren son:

• Abierto AI
• Google OAuth
• Google PubSub: consulte las instrucciones de configuración a continuación
• Upstash Redis: también puede utilizar Redis normal con Docker Compose.
• Tinybird: puedes ejecutar la aplicación sin esto, pero algunas funciones se desactivarán.

Usamos Postgres para la base de datos.

Puede ejecutar Postgres y Redis localmente usando docker-compose

docker-compose up -d # -d will run the services in the background

Crea tu propio archivo .env :

cp apps/web/.env.example apps/web/.env
cd apps/web
pnpm install

Establezca las variables de entorno en el .env recién creado. Puede ver una lista de variables requeridas en: apps/web/env.ts .

Las variables de entorno requeridas:

• NEXTAUTH_SECRET : puede ser cualquier cadena aleatoria (intente usar openssl rand -hex 32 para obtener una cadena aleatoria rápida y segura)
• GOOGLE_CLIENT_ID : ID de cliente de Google OAuth. Más información aquí
• GOOGLE_CLIENT_SECRET : secreto del cliente Google OAuth. Más información aquí
• OPENAI_API_KEY : clave API de OpenAI.
• UPSTASH_REDIS_URL : URL de Redis desde Upstash.
• UPSTASH_REDIS_TOKEN : token de Redis de Upstash.
• TINYBIRD_TOKEN : token de administrador para su espacio de trabajo de Tinybird (asegúrese de crear una instancia en la región GCP us-east4 . Esto también se puede cambiar a través de su .env si prefiere una región diferente). También puede decidir deshabilitar Tinybird y luego se deshabilitarán las funciones de análisis y cancelación masiva de suscripción. Establece NEXT_PUBLIC_DISABLE_TINYBIRD=true si decides desactivar Tinybird.

Para ejecutar las migraciones:

pnpm prisma migrate dev

Para ejecutar la aplicación localmente:

pnpm run dev

O desde la raíz del proyecto:

turbo dev

Abra http://localhost:3000 para verlo en su navegador. Para actualizarse a administrador, visite: http://localhost:3000/admin.

Configuración de Google OAuth y API de Gmail

Debe habilitar estos ámbitos en Google Cloud Console:

 https://www.googleapis.com/auth/userinfo.profile
https://www.googleapis.com/auth/userinfo.email
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/contacts

Configurando Tinybird

Siga las instrucciones aquí para configurar las pipes y datasources .

Opcional: si también desea almacenar estadísticas de uso de IA en Tinybird, haga lo mismo en /packages/tinybird-ai-analytics .

Configure notificaciones push a través de Google PubSub para manejar correos electrónicos en tiempo real

Siga las instrucciones aquí.

1. crear un tema
2. Crear una suscripción
3. Otorga derechos de publicación sobre tu tema

Establezca la var de entorno GOOGLE_PUBSUB_TOPIC_NAME . Al crear la suscripción, seleccione Push y la URL debería verse así: https://www.getinboxzero.com/api/google/webhook?token=TOKEN o https://abc.ngrok-free.app/api/google/webhook?token=TOKEN donde el dominio es su dominio. Establezca GOOGLE_PUBSUB_VERIFICATION_TOKEN en su archivo .env como el valor de TOKEN .

Para ejecutar ngrok en desarrollo puede resultar útil:

ngrok http 3000
# or with an ngrok domain to keep your endpoint stable (set `XYZ`):
ngrok http --domain=XYZ.ngrok-free.app 3000

Y luego actualice el punto final del webhook en el panel de suscripciones de Google PubSub.

Para comenzar a ver correos electrónicos, visite: /api/google/watch/all