Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elie222/inbox-zero

Open source email app to reach inbox zero fast.
https://github.com/elie222/inbox-zero

ai email nextjs openai prisma productivity shadcn-ui tailwind turborepo typescript upstash

Last synced: about 2 months ago
JSON representation

Open source email app to reach inbox zero fast.

Host: GitHub
URL: https://github.com/elie222/inbox-zero
Owner: elie222
License: agpl-3.0
Created: 2023-07-12T15:34:57.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-04-28T13:07:41.000Z (5 months ago)
Last Synced: 2024-04-29T18:15:19.577Z (5 months ago)
Topics: ai, email, nextjs, openai, prisma, productivity, shadcn-ui, tailwind, turborepo, typescript, upstash
Language: TypeScript
Homepage: https://www.getinboxzero.com
Size: 8.16 MB
Stars: 1,901
Watchers: 9
Forks: 146
Open Issues: 48
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

jimsghstars - elie222/inbox-zero - Open source email app to reach inbox zero fast. (TypeScript)

README

        [![](apps/web/app/opengraph-image.png)](https://www.getinboxzero.com)



  

    
Inbox Zero


  

  


    Open source email app to reach inbox zero fast.

    


    Website

    ·

    Discord

    ·

    Issues

    ·

    Kanban

  


## About

Inbox Zero is an open-source email app whose goal is to help you reach inbox zero fast with AI assistance.

## Demo Video

[![Inbox Zero demo](/video-thumbnail.png)](http://www.youtube.com/watch?v=kc_9WZ1ZWyg)

## Key Features

- **Newsletter Cleaner:** Easily manage and unsubscribe from newsletters.

- **AI Assistant:** Auto respond, archive, label, and forward emails based on plain text prompt rules.

- **Cold Email Blocker:** Automatically block cold emails.

- **Email Analytics:** Track your email activity with daily, weekly, and monthly stats.

- **New Senders:** Identify and block new spam senders.

- **Unreplied Emails:** Keep track of emails awaiting responses.

- **Large Email Finder:** Free up space by locating and deleting large emails.

## Built with

- [Next.js](https://nextjs.org/)

- [Tailwind CSS](https://tailwindcss.com/)

- [shadcn/ui](https://ui.shadcn.com/)

- [Prisma](https://www.prisma.io/)

- [Tinybird](https://tinybird.co/)

- [Upstash](https://upstash.com/)

- [Turbo](https://turbo.build/)

## Feature Requests

To request a feature open a [GitHub issue](https://github.com/elie222/inbox-zero/issues). If you don't have a GitHub account you can request features [here](https://www.getinboxzero.com/feature-requests). Or join our [Discord](https://www.getinboxzero.com/discord).

## Getting Started for Developers

### Contributing to the project

We have a public Kanban available [here](https://github.com/users/elie222/projects/1/views/1). Join our [Discord](https://www.getinboxzero.com/discord) to discuss tasks and check what's being worked on.

### Requirements

- [Node.js](https://nodejs.org/en/) >= 18.0.0

- [pnpm](https://pnpm.io/) >= 8.6.12

- [Docker desktop](https://www.docker.com/products/docker-desktop/) (optional)

### Setup

[Here's a video](https://youtu.be/hVQENQ4WT2Y) on how to set up the project. It covers the same steps mentioned in this document. But goes into greater detail on setting up the external services.

The external services that are required are:

- [OpenAI](https://platform.openai.com/api-keys)

- [Google OAuth](https://console.cloud.google.com/apis/credentials)

- [Google PubSub](https://console.cloud.google.com/cloudpubsub/topic/list) - see set up instructions below

- [Upstash Redis](https://upstash.com/) - you can also use regular Redis with the Docker Compose.

- [Tinybird](https://www.tinybird.co/) - you can run the app without this but some features then will be disabled.

We use Postgres for the database.

You can run Postgres & Redis locally using `docker-compose`

```bash

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

```

Create your own `.env` file:

```bash

cp apps/web/.env.example apps/web/.env

cd apps/web

pnpm install

```

Set the environment variables in the newly created `.env`. You can see a list of required variables in: `apps/web/env.ts`.

The required environment variables:

- `NEXTAUTH_SECRET` -- can be any random string (try using `openssl rand -hex 32` for a quick secure random string)

- `GOOGLE_CLIENT_ID` -- Google OAuth client ID. More info [here](https://next-auth.js.org/providers/google)

- `GOOGLE_CLIENT_SECRET` -- Google OAuth client secret. More info [here](https://next-auth.js.org/providers/google)

- `OPENAI_API_KEY` -- OpenAI API key.

- `UPSTASH_REDIS_URL` -- Redis URL from Upstash.

- `UPSTASH_REDIS_TOKEN` -- Redis token from Upstash.

- `TINYBIRD_TOKEN` -- Admin token for your Tinybird workspace (be sure to create an instance in the GCP `us-east4` region. This can also be changed via your `.env` if you prefer a different region). You can also decide to disabled Tinybird and then the analytics and bulk unsubscribe features will be disabled. Set `NEXT_PUBLIC_DISABLE_TINYBIRD=true` if you decide to disable Tinybird.

To run the migrations:

```bash

pnpm prisma migrate dev

```

To run the app locally:

```bash

pnpm run dev

```

Or from the project root:

```bash

turbo dev

```

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

To upgrade yourself to admin visit: [http://localhost:3000/admin](http://localhost:3000/admin).

### Setting up Google OAuth and Gmail API

You need to enable these scopes in the Google Cloud Console:

```plaintext

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

```

### Setting up Tinybird

Follow the instructions [here](./packages/tinybird/README.md) to setup the `pipes` and `datasources`.

Optional: If you want to store AI usage stats in Tinybird too, then do the same in `/packages/tinybird-ai-analytics`.

### Set up push notifications via Google PubSub to handle emails in real time

Follow instructions [here](https://developers.google.com/gmail/api/guides/push).

1. [Create a topic](https://developers.google.com/gmail/api/guides/push#create_a_topic)

2. [Create a subscription](https://developers.google.com/gmail/api/guides/push#create_a_subscription)

3. [Grant publish rights on your topic](https://developers.google.com/gmail/api/guides/push#grant_publish_rights_on_your_topic)

Set env var `GOOGLE_PUBSUB_TOPIC_NAME`.

When creating the subscription select Push and the url should look something like: `https://www.getinboxzero.com/api/google/webhook?token=TOKEN` or `https://abc.ngrok-free.app/api/google/webhook?token=TOKEN` where the domain is your domain. Set `GOOGLE_PUBSUB_VERIFICATION_TOKEN` in your `.env` file to be the value of `TOKEN`.

To run in development ngrok can be helpful:

```sh

ngrok http 3000

```

And then update the webhook endpoint in the [Google PubSub subscriptions dashboard](https://console.cloud.google.com/cloudpubsub/subscription/list).

To start watching emails visit: `/api/google/watch/all`