💌 A beautiful, fast and fully open source mail client for Mac, Windows and Linux.
Find a file
2017-09-03 17:20:52 -07:00
app AppVeyor: Build Mailsync for Windows (fingers crossed…) 2017-09-03 17:17:00 -07:00
mailsync@5d0296ba5c AppVeyor: Build Mailsync for Windows (fingers crossed…) 2017-09-03 17:17:00 -07:00
screenshots
scripts Stop shipping an entire extra copy of Electron inside the app… 🙃 2017-09-01 23:22:35 -07:00
.appveyor.yml AppVeyor: Add decryption secrets 2017-09-03 17:20:52 -07:00
.babelrc
.coffeelint.json
.eslintrc
.gitignore
.gitmodules
.travis.yml Travis: Setup mac keychain before building C++ 2017-08-31 12:27:07 -07:00
book.json
CHANGELOG.md
CONTRIBUTING.md
ISSUE_TEMPLATE.md Rename the nylas: URL scheme to merani: 2017-08-16 13:31:26 -07:00
LICENSE.md
package.json Stop shipping an entire extra copy of Electron inside the app… 🙃 2017-09-01 23:22:35 -07:00
README.md
ROADMAP.md

💌 Merani

Travis Status AppVeyor Status

Hello! I'm one of the original authors of Nylas Mail and this is a significant fork of the app which completely replaces JavaScript mail sync with a C++ core built on Mailcore2. Unfortunately, it's not ready for use - check back soon!

Merani Screenshot

High level Goals:

  • Replace JavaScript mail sync (client-sync package) and the Electron "worker window" with a new, high performance codebase written in C++ and based on Mailcore2. Make the Electron application just the UI layer.
    • One C++ process per email account.
    • C++ and JS communicate via the child process stdin/stdout streams.
    • JS application queues tasks but has read-only access to the database.
    • JS application should not install timers or wake /at all/ when idle. 0% battery impact when idle.
  • Improve performance of the thread list and composer contenteditable.
  • Make windows open faster by just having less code.
  • Bring back mail rules.

Roadmap and Progress:

See ROADMAP.md


Merani is an open-source mail client built on the modern web with Electron, React, and Flux. It is designed to be extensible, so it's easy to create new experiences and workflows around email. Want to learn more? Check out the full documentation.

Slack Invite Button

Download Merani

You can download compiled versions of Merani for Windows, Mac OS X, and Linux (.deb) from https://getmerani.com/download. You can also build and run Merani (Previously N1) on Fedora. On Arch Linux, you can install n1 or n1-git from the aur.

Build A Plugin

Plugins lie at the heart of Merani and give it its powerful features. Building your own plugins allows you to integrate the app with other tools, experiment with new workflows, and more. Follow the Getting Started guide to write your first plugin in five minutes. To create your own theme, go to our Theme Starter guide.

If you would like to run the N1 source and contribute, check out our contributing guide.

Themes

The Merani user interface is styled using CSS, which means it's easy to modify and extend. Merani comes stock with a few beautiful themes, and there are many more which have been built by community developers

Bundled Themes

Community Themes

To install community themes:

  1. Download and unzip the repo
  2. In Merani, select Developer > Install a Package Manually...
  3. Navigate to where you downloaded the theme and select the root folder. The theme is copied into the Merani settings folder for your convinence
  4. Select Change Theme... from the top level menu, and you'll see the newly installed theme. That's it!

Want to dive in more? Try creating your own theme!

Plugin List

We're working on building a plugin index that makes it super easy to add them to Merani. For now, check out the list below! (Feel free to submit a PR if you build a plugin and want it featured here.)

Bundled Plugins

Great starting points for creating your own plugins!

Configuration

You can configure Merani in a few ways—for instance, pointing it to your self-hosted instance of the sync engine or changing the interface zoom level. Learn more about how.

Feature Requests / Plugin Ideas

Have an idea for a package or a feature you'd love to see in Merani? Search for existing GitHub issues and join the conversation!