base on Experience email the way you want with 0 – the first open source email app that puts your privacy and safety first. Join the discord: https://discord.gg/0email <p align="center"> <picture> <source srcset="apps/mail/public/white-icon.svg" media="(prefers-color-scheme: dark)"> <img src="apps/mail/public/black-icon.svg" alt="Zero Logo" width="64" style="background-color: #000; padding: 10px;"/> </picture> </p> # Zero An Open-Source Gmail Alternative for the Future of Email ## What is Zero? Zero is an open-source AI email solution that gives users the power to **self-host** their own email app while also integrating external services like Gmail and other email providers. Our goal is to modernize and improve emails through AI agents to truly modernize emails. ## Why Zero? Most email services today are either **closed-source**, **data-hungry**, or **too complex to self-host**. 0.email is different: - ✅ **Open-Source** – No hidden agendas, fully transparent. - 🦾 **AI Driven** - Enhance your emails with Agents & LLMs. - 🔒 **Data Privacy First** – Your emails, your data. Zero does not track, collect, or sell your data in any way. Please note: while we integrate with external services, the data passed through them is not under our control and falls under their respective privacy policies and terms of service. - ⚙️ **Self-Hosting Freedom** – Run your own email app with ease. - 📬 **Unified Inbox** – Connect multiple email providers like Gmail, Outlook, and more. - 🎨 **Customizable UI & Features** – Tailor your email experience the way you want it. - 🚀 **Developer-Friendly** – Built with extensibility and integrations in mind. ## Tech Stack Zero is built with modern and reliable technologies: - **Frontend**: Next.js, React, TypeScript, TailwindCSS, Shadcn UI - **Backend**: Node.js, Drizzle ORM - **Database**: PostgreSQL - **Authentication**: Better Auth, Google OAuth <!-- - **Testing**: Jest, React Testing Library --> ## Getting Started ### Prerequisites **Required Versions:** - [Node.js](https://nodejs.org/en/download) (v18 or higher) - [pnpm](https://pnpm.io) (v10 or higher) - [Docker](https://docs.docker.com/engine/install/) (v20 or higher) Before running the application, you'll need to set up services and configure environment variables. For more details on environment variables, see the [Environment Variables](#environment-variables) section. ### Setup Options You can set up Zero in two ways: <details open> <summary><b>Standard Setup (Recommended)</b></summary> #### Quick Start Guide 1. **Clone and Install** ```bash # Clone the repository git clone https://github.com/Mail-0/Zero.git cd Zero # Install dependencies pnpm install # Start database locally pnpm docker:db:up ``` 2. **Set Up Environment** - Run `pnpm nizzy env` to setup your environment variables - Run `pnpm nizzy sync` to sync your environment variables and types - Start the database with the provided docker compose setup: `pnpm docker:db:up` - Initialize the database: `pnpm db:push` 3. **Start the App** ```bash pnpm dev ``` 4. **Open in Browser** Visit [http://localhost:3000](http://localhost:3000) </details> <details open> <summary><b>Devcontainer Setup</b></summary> #### Quick Start guide 1. **Clone and Install** ```bash # Clone the repository git clone https://github.com/Mail-0/Zero.git cd Zero ``` Then open the code in devcontainer and install the dependencies: ``` pnpm install # Start the database locally pnpm docker:db:up ``` 2. **Set Up Environment** - Run `pnpm nizzy env` to setup your environment variables - Run `pnpm nizzy sync` to sync your environment variables and types - Start the database with the provided docker compose setup: `pnpm docker:db:up` - Initialize the database: `pnpm db:push` 3. **Start The App** ```bash pnpm dev ``` Visit [http://localhost:3000](http://localhost:3000) </details> ### Environment Setup 1. **Better Auth Setup** - Open the `.env` file and change the BETTER_AUTH_SECRET to a random string. (Use `openssl rand -hex 32` to generate a 32 character string) ```env BETTER_AUTH_SECRET=your_secret_key ``` 2. **Google OAuth Setup** (Required for Gmail integration) - Go to [Google Cloud Console](https://console.cloud.google.com) - Create a new project - Add the following APIs in your Google Cloud Project: [People API](https://console.cloud.google.com/apis/library/people.googleapis.com), [Gmail API](https://console.cloud.google.com/apis/library/gmail.googleapis.com) - 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:8787/api/auth/callback/google` - Production: - `https://your-production-url/api/auth/callback/google` - Add to `.env`: ```env GOOGLE_CLIENT_ID=your_client_id GOOGLE_CLIENT_SECRET=your_client_secret ``` - Add yourself as a test user: - Go to [`Audience`](https://console.cloud.google.com/auth/audience) - Under 'Test users' click 'Add Users' - Add your email and click 'Save' > [!WARNING] > The authorized redirect URIs in Google Cloud Console must match **exactly** what you configure in the `.env`, including the protocol (http/https), domain, and path - these are provided above. 3. **Autumn Setup** (Required for some encryption) -Go to [Autumn](https://useautumn.com/) -For Local Use, click [onboarding](https://app.useautumn.com/sandbox/onboarding) button and generate an Autumn Secret Key -For production, select the production mode from upper left corner and generate an fill the other fields. After that, generate an Autumn Secret Key - Add to `.env`: ```env AUTUMN_SECRET_KEY=your_autumn_secret ``` ### Environment Variables Run `pnpm nizzy env` to setup your environment variables. It will copy the `.env.example` file to `.env` and fill in the variables for you. For local development a connection string example is provided in the `.env.example` file located in the same folder as the database. ### Database Setup Zero uses PostgreSQL for storing data. Here's how to set it up: 1. **Start the Database** Run this command to start a local PostgreSQL instance: ```bash pnpm docker:db:up ``` This creates a database with: - Name: `zerodotemail` - Username: `postgres` - Password: `postgres` - Port: `5432` 2. **Set Up Database Connection** Make sure your database connection string is in `.env` file. And you have ran `pnpm nizzy sync` to sync the latest env. For local development use: ``` DATABASE_URL="postgresql://postgres:postgres@localhost:5432/zerodotemail" ``` 3. **Database Commands** - **Set up database tables**: ```bash pnpm db:push ``` - **Create migration files** (after schema changes): ```bash pnpm db:generate ``` - **Apply migrations**: ```bash pnpm db:migrate ``` - **View database content**: ```bash pnpm db:studio ``` > If you run `pnpm dev` in your terminal, the studio command should be automatically running with the app. ## Contribute Please refer to the [contributing guide](.github/CONTRIBUTING.md). If you'd like to help with translating Zero to other languages, check out our [translation guide](.github/TRANSLATION.md). ## Star History [](https://www.star-history.com/#Mail-0/Zero&Timeline) ## This project wouldn't be possible without these awesome companies <div style="display: flex; justify-content: center;"> <a href="https://vercel.com" style="text-decoration: none;"> <img src="public/vercel.png" alt="Vercel" width="96"/> </a> <a href="https://better-auth.com" style="text-decoration: none;"> <img src="public/better-auth.png" alt="Better Auth" width="96"/> </a> <a href="https://orm.drizzle.team" style="text-decoration: none;"> <img src="public/drizzle-orm.png" alt="Drizzle ORM" width="96"/> </a> <a href="https://coderabbit.com" style="text-decoration: none;"> <img src="public/coderabbit.png" alt="Coderabbit AI" width="96"/> </a> </div> ## 🤍 The team Curious who makes Zero? Here are our [contributors and maintainers](https://0.email/contributors) ", Assign "at most 3 tags" to the expected json: {"id":"13677","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"