đź’Ś An extensible desktop mail app built on the modern web.
JavaScript CoffeeScript HTML CSS Shell Visual Basic
Latest commit f35008d Nov 22, 2016 @agsdot agsdot committed with grinich Typo: mispelled > misspelled (#3085)
Permalink
Failed to load latest commit information.
apm build(*): electron-compile, electron-packager instead of custom tooling Nov 9, 2016
build fix(mailto): Restore AtomApplication breaking Mailto Nov 22, 2016
docs fix(docs): We no longer support Node 4 for building Nov 9, 2016
dot-nylas bump(version): 0.4.200 Oct 26, 2016
flow-typed rm(grim): We’re not using Grim for deprecations Oct 25, 2016
internal_packages fix(spellcheck): fix right click menu on spellcheck Nov 22, 2016
keymaps es6(composer): Composer extensions => ES2016 Oct 28, 2016
menus fix(menus): Add missing `Window` menu to win32 and linux Jun 10, 2016
script fix(bootstrap): Build deps for current arch Nov 21, 2016
spec fix(lint): fix linter import error Nov 18, 2016
spec_integration fix(spec): remove unnecessary messages & prevent extra hot window Sep 29, 2016
src feat(calendar): Allow calendar events to be dragged and resized Nov 22, 2016
static feat(calendar): Allow calendar events to be dragged and resized Nov 22, 2016
.eslintrc Update grunt tasks to lint and transpile es6 code using babel Nov 7, 2015
.flowconfig feat(flow): Add Flow to Nylas N1 Oct 25, 2016
.gitignore Bump src/pro pointer Nov 21, 2016
.gitmodules Revert "Link K2 into N1 as a private submodule" Nov 21, 2016
.travis.yml fix(builds): Stop when tests fail, use Appveyor build phases Nov 9, 2016
CHANGELOG.md Typo: mispelled > misspelled (#3085) Nov 22, 2016
CONFIGURATION.md feat(self-hosting): Add onboarding flow for self-hosted sync engine Jul 21, 2016
CONTRIBUTING.md fix(docs): We no longer support Node 4 for building Nov 9, 2016
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md Jul 23, 2016
LICENSE.md fix(license): Swap ref to GPLv3 with the whole thing so GitHub picks … Oct 15, 2016
README.md fix(readme): Remove readme to prevent overwriting on script/bootstrap Nov 9, 2016
appveyor.yml fix(build): reset appveyor cache on package change Nov 21, 2016
keymap.json fix(config): Move all reads / writes to the main process May 16, 2016
package.json bump(version): 0.4.400 Nov 22, 2016

README.md

N1 Logo

N1 Screenshot

N1 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. N1 is built on the Nylas Sync Engine, which is also open-source free software.

Build Status Slack Invite Button GitHub issues On Deck

Want help build the future of email? Nylas is hiring!

Download N1

You can download compiled versions of N1 for Windows, Mac OS X, and Linux (.deb) from https://nylas.com/N1. You can also build and run 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 N1 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 Nylas N1 user interface is styled using CSS, which means it's easy to modify and extend. N1 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 Nylas N1, 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 ~/.nylas 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 N1. 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!

Community Plugins

Note these are not tested or officially supported by Nylas, but we still think they are really cool! If you find bugs with them, please open GitHub issues on their individual project pages, not the N1 repo page. Thanks!

When you install packages, they're moved to ~/.nylas/packages, and N1 runs apm install on the command line to fetch dependencies listed in the package's package.json

Configuration

You can configure N1 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 N1? Check out our public Trello board to contribute your thoughts and vote on existing ideas.