💌 A beautiful, fast and fully open source mail client for Mac, Windows and Linux.
Find a file
Juan Tejada f47194fee1 fix(win-build): Change to 'cmd' for build script
This should prevent it from failing on npm install warnings
2016-11-18 11:01:21 -08:00
apm build(*): electron-compile, electron-packager instead of custom tooling 2016-11-09 13:52:10 -08:00
build feat(lint): upgrade linter and add exceptions for dumb new rules 2016-11-15 09:56:39 -08:00
docs fix(docs): We no longer support Node 4 for building 2016-11-09 15:51:05 -08:00
dot-nylas bump(version): 0.4.200 2016-10-26 19:48:22 -04:00
flow-typed rm(grim): We’re not using Grim for deprecations 2016-10-25 11:36:20 -07:00
internal_packages fix(search): allow custom search result elements 2016-11-17 16:01:55 -08:00
keymaps es6(composer): Composer extensions => ES2016 2016-10-27 17:28:36 -07:00
menus fix(menus): Add missing Window menu to win32 and linux 2016-06-10 11:55:59 -07:00
script ci(*): Travis and AppVeyor changes, script cleanup 2016-11-09 14:13:09 -08:00
spec fix(specs) Fix remaining tests 2016-11-17 15:37:44 -08:00
spec_integration fix(spec): remove unnecessary messages & prevent extra hot window 2016-09-29 09:52:51 -05:00
src fix(db): fix error with modelify not finding markNotBackgroundable 2016-11-17 16:02:42 -08:00
static feat(calendar): Add line showing ‘now’ 2016-11-16 17:08:56 -08:00
.eslintrc Update grunt tasks to lint and transpile es6 code using babel 2015-11-06 17:40:42 -08:00
.flowconfig feat(flow): Add Flow to Nylas N1 2016-10-24 22:44:16 -04:00
.gitignore build(*): electron-compile, electron-packager instead of custom tooling 2016-11-09 13:52:10 -08:00
.gitmodules feat(package): fix build-resources-task and move submodule 2016-04-25 16:01:56 -07:00
.travis.yml fix(builds): Stop when tests fail, use Appveyor build phases 2016-11-09 14:40:27 -08:00
appveyor.yml fix(win-build): Change to 'cmd' for build script 2016-11-18 11:01:21 -08:00
CHANGELOG.md bump(version): 0.4.204 2016-11-07 14:16:50 -08:00
CONFIGURATION.md feat(self-hosting): Add onboarding flow for self-hosted sync engine 2016-07-21 14:25:30 -07:00
CONTRIBUTING.md fix(docs): We no longer support Node 4 for building 2016-11-09 15:51:05 -08:00
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md 2016-07-23 13:03:38 -07:00
keymap.json fix(config): Move all reads / writes to the main process 2016-05-16 16:38:46 -05:00
LICENSE.md fix(license): Swap ref to GPLv3 with the whole thing so GitHub picks it up 2016-10-15 10:48:44 -07:00
package.json feat(lint): upgrade linter and add exceptions for dumb new rules 2016-11-15 09:56:39 -08:00
README.md fix(readme): Remove readme to prevent overwriting on script/bootstrap 2016-11-09 15:16:44 -08:00

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](https://badge.waffle.io/nylas/N1.png?label=on deck&title=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.