base on Open source email app to reach inbox zero fast. [](https://www.getinboxzero.com) <p align="center"> <a href="https://www.getinboxzero.com"> <h1 align="center">Inbox Zero</h1> </a> <p align="center"> Open source email app to reach inbox zero fast. <br /> <a href="https://www.getinboxzero.com">Website</a> · <a href="https://www.getinboxzero.com/discord">Discord</a> · <a href="https://github.com/elie222/inbox-zero">Issues</a> · <a href="https://github.com/users/elie222/projects/1">Kanban</a> </p> </p> ## About Inbox Zero is an open-source email app whose goal is to help you reach inbox zero fast with AI assistance. ## Demo Video [](http://www.youtube.com/watch?v=hfvKvTHBjG0) ## 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). ### Supported LLMs For the LLM, you can use Anthropic, OpenAI, or Anthropic on AWS Bedrock. You can also use Ollama by setting the following enviroment variables: ```sh OLLAMA_BASE_URL=http://localhost:11434/api NEXT_PUBLIC_OLLAMA_MODEL=phi3 ``` You can select the model you wish to use in the app on the `/settings` page of the app. ### 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 # or with an ngrok domain to keep your endpoint stable (set `XYZ`): ngrok http --domain=XYZ.ngrok-free.app 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` ", Assign "at most 3 tags" to the expected json: {"id":"6400","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"