Open source email app to reach inbox zero fast.
About Inbox Zero
Inbox Zero is an open-source email application designed to help you swiftly reach that coveted state of having zero unread emails. With the assistance of AI, Inbox Zero aims to make your email management effortless and efficient.
Key Features
- Newsletter Cleaner: Easily manage and unsubscribe from unwanted newsletters.
- AI Assistant: Automatically respond, archive, label, and forward emails using uncomplicated plain text prompts.
- Cold Email Blocker: Automatically blocks unsolicited cold emails.
- Email Analytics: Gain insights on your email activity with daily, weekly, and monthly statistics.
- New Senders: Identify and block new spam senders effortlessly.
- Unreplied Emails: Keep track of emails that are still awaiting your response.
- Large Email Finder: Locates and helps delete large emails to free up space.
Getting Started for Developers
Curious about contributing to this project? Here’s a quick guide to get you set up!
Requirements
- Node.js >= 18.0.0
- pnpm = 8.6.12
- Docker Desktop (optional)
Setup
To set up your environment, follow these steps:
bash
# Run services in the background
docker-compose up -d
# Create a new .env file
cp apps/web.env.example apps/web.env
cd apps/web
pnpm install
Next, fill in the required environment variables in your newly created .env file. Here’s what you’ll need:
- NEXTAUTH_SECRET: Any random string. You can generate it using:
openssl rand -hex 32. - GOOGLE_CLIENT_ID: Your Google OAuth client ID.
- GOOGLE_CLIENT_SECRET: Your Google OAuth client secret.
- OPENAI_API_KEY: Your API key for OpenAI.
- UPSTASH_REDIS_URL: Redis URL from Upstash.
- UPSTASH_REDIS_TOKEN: Redis token from Upstash.
- TINYBIRD_TOKEN: Admin token for your Tinybird workspace.
To launch the application in development mode, execute:
bash
# Run migrations
pnpm prisma migrate dev
# Start the app
pnpm run dev
# OR from the project root
turbo dev
Access the application by navigating to http://localhost:3000.
Setting up Google OAuth and Gmail API
Activate the necessary scopes in the Google Cloud Console:
Understanding the Code – An Analogy
The code provided for setting up Inbox Zero is akin to building a restaurant from the ground up. Each section represents a crucial part of the construction process:
- Requirements: Think of this as gathering your team of expert chefs, waitstaff, and hosts necessary to run a successful establishment.
- Setup: This is like drafting the restaurant blueprint and ensuring you have all the necessary tools and resources (ingredients) to bring your vision to life. Each command is a step towards laying down your restaurant’s foundation.
- Running Migrations: Similar to ensuring your kitchen is stocked and your tables are set for a busy dinner service, running migrations allows your database to keep up with the ever-changing menu of your email app.
- Launching the App: This is the grand opening of your restaurant where you welcome patrons (users) to experience the vibrant ambiance of your meticulously crafted space.
Troubleshooting Tips
If you encounter issues while setting up or running Inbox Zero, consider the following troubleshooting steps:
- Ensure all required environment variables are correctly set up in the .env file.
- Check if your Node.js and pnpm versions are correct.
- Consult the Docker logs for any issues with running services.
- If you’re having trouble with Google authentication, verify that you have enabled the necessary scopes in your Google Cloud Console.
- Refer to the GitHub issues page for more community-driven support.
For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.
Conclusion
At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.