mirror of
https://github.com/Mail-0/Zero.git
synced 2026-06-29 15:26:42 +00:00
Update README.md (#396)
This commit is contained in:
nizzy
141
README.md
141
README.md
@@ -4,118 +4,22 @@
|
||||
|
||||
An Open-Source Gmail Alternative for the Future of Email
|
||||
|
||||
## Table of Contents <!-- omit from toc -->
|
||||
|
||||
- [Zero](#zero)
|
||||
- [What is Zero?](#what-is-zero)
|
||||
- [Why Zero?](#why-zero)
|
||||
- [Our Mission](#our-mission)
|
||||
- [Documentation](#documentation)
|
||||
- [Roadmap 🛤️](#roadmap-️)
|
||||
- [1. Core Email Connectivity](#1-core-email-connectivity)
|
||||
- [2. Email Usage Improvements](#2-email-usage-improvements)
|
||||
- [3. Infrastructure](#3-infrastructure)
|
||||
- [Development Priorities](#development-priorities)
|
||||
- [Join the Movement 🚀](#join-the-movement-)
|
||||
- [Stay Tuned](#stay-tuned)
|
||||
- [Tech Stack](#tech-stack)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Environment Variables](#environment-variables)
|
||||
- [Update the PostgreSQL database accordingly](#update-the-postgresql-database-accordingly)
|
||||
- [Running Locally](#running-locally)
|
||||
- [Contribute](#contribute)
|
||||
- [Issues](#issues)
|
||||
- [Create a new issue](#create-a-new-issue)
|
||||
- [Solve an issue](#solve-an-issue)
|
||||
- [Pull Request](#pull-request)
|
||||
- [License](#license)
|
||||
|
||||
## What is Zero?
|
||||
|
||||
Zero is an open-source 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 put **control, privacy, and customization** back into the hands of users—whether they choose to host their email independently or manage multiple inboxes from a single, customizable platform.
|
||||
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. No tracking, no selling, no middlemen.
|
||||
⚙️ **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.
|
||||
|
||||
## Our Mission
|
||||
|
||||
We believe email should be:
|
||||
|
||||
1. **Yours** – You control where your data is stored.
|
||||
2. **Flexible** – Use it however you want—self-hosted or connected to third-party providers.
|
||||
3. **Open** – Transparent development, open collaboration, and community-driven innovation.
|
||||
4. **User-Friendly** – No need for technical expertise to get started.
|
||||
|
||||
## Documentation
|
||||
|
||||
- [License](LICENSE) - Project license and terms
|
||||
- [Roadmap](ROADMAP.md) - Development plans and future features
|
||||
|
||||
## Roadmap 🛤️
|
||||
|
||||
This document outlines the development roadmap for Zero. Our vision is to create a powerful, user-friendly, and privacy-focused email experience.
|
||||
|
||||
### 1. Core Email Connectivity
|
||||
|
||||
- Connect main email providers
|
||||
- Support for multiple email accounts
|
||||
- Unified inbox experience
|
||||
|
||||
### 2. Email Usage Improvements
|
||||
|
||||
- AI-powered email assistance
|
||||
- Advanced drag-and-drop tools
|
||||
- Customizable keyboard shortcuts
|
||||
- Performance optimization
|
||||
- Enhanced search capabilities
|
||||
- Deep customization options
|
||||
|
||||
### 3. Infrastructure
|
||||
|
||||
- Domain management
|
||||
- Optimized email client
|
||||
- Self-hosting support
|
||||
|
||||
## Development Priorities
|
||||
|
||||
1. Building a robust foundation for email management
|
||||
2. Implementing user-requested features
|
||||
3. Ensuring seamless integration with existing email providers
|
||||
4. Maintaining high performance and reliability
|
||||
|
||||
We welcome community input and contributions to help shape these features and priorities. If you have suggestions or would like to contribute, please:
|
||||
|
||||
1. Open an issue to discuss new feature ideas
|
||||
2. Submit pull requests for improvements
|
||||
3. Join discussions in existing issues
|
||||
|
||||
This roadmap is a living document and will be updated as development progresses and priorities evolve based on community feedback and technological advances.
|
||||
|
||||
## Join the Movement 🚀
|
||||
|
||||
Zero is not just another email app—it's a **vision** for a better, more open, and user-controlled email ecosystem. If you believe in **privacy**, **open-source software**, and **giving users control**, we'd love for you to join us!
|
||||
|
||||
📢 **Follow our progress** – Stay updated on GitHub as we build Zero.
|
||||
💡 **Contribute** – Share your ideas, suggest features, and help shape the project.
|
||||
🤝 **Community-driven** – Our goal is to create an email solution **for the people, by the people**.
|
||||
|
||||
### Stay Tuned
|
||||
|
||||
We're just getting started. If you're excited about a future where **email belongs to users, not corporations**, let's make it happen together.
|
||||
|
||||
---
|
||||
|
||||
🤍 **Zero – Email, Reimagined.**
|
||||
|
||||
## Tech Stack
|
||||
|
||||
Zero is built with modern and reliable technologies:
|
||||
@@ -259,45 +163,8 @@ Run the development server:
|
||||
cd apps/mail
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
## Contribute
|
||||
## Star History
|
||||
|
||||
1. You can fork the repository and make changes to your forked repository. Once you have made your changes, you can create a pull request to the main branch.
|
||||
2. To add code to the main branch, make a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). **Your code will always be reviewed by a maintainer, not yourself!**
|
||||
|
||||
## Issues
|
||||
|
||||
### Create a new issue
|
||||
|
||||
If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/Mail-0/Mail-0/issues/new?template=Blank+issue).
|
||||
|
||||
### Solve an issue
|
||||
|
||||
Scan through our [existing issues](https://github.com/Mail-0/Mail-0/issues) to find one that interests you. You can narrow down the search using `labels` as filters. For more information, see "[Label reference](https://docs.github.com/en/contributing/collaborating-on-github-docs/label-reference)". As a general rule, we don't assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
|
||||
|
||||
## Pull Request
|
||||
|
||||
When you're finished with the changes, create a pull request, also known as a PR.
|
||||
|
||||
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
|
||||
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
|
||||
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
|
||||
Once you submit your PR, a reviewer will review your proposal. We may ask questions or request additional information.
|
||||
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork and then commit them to your branch.
|
||||
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
|
||||
- If you run into any merge issues, check out this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
|
||||
|
||||
## License
|
||||
|
||||
0.email is licensed under the MIT License. This means you can:
|
||||
|
||||
✅ Use the software commercially, as is.
|
||||
✅ Modify the source code, and
|
||||
✅ Distribute your modifications, and
|
||||
✅ Use and modify the software *privately*
|
||||
|
||||
The only requirement is that you include the original copyright and license notice in any copy of the software/source.
|
||||
|
||||
See the [LICENSE](LICENSE) file for the full license text.
|
||||
[](https://star-history.com/#Mail-0/Mail-0&Timeline)
|
||||
|
||||
Reference in New Issue
Block a user