💌 A beautiful, fast and fully open source mail client for Mac, Windows and Linux.
Find a file
Evan Morikawa 7aefb73ef8 feat(usage): add new feature usage modal
Summary:
This adds the "You've reached max features" modal in N1.

http://g.recordit.co/9O7R0mLlXE.gif

Test Plan:
1. Pull latest nylas/cloud-core and start Billing site:
```
  cd cloud-core
  vagrant up
  vagrant ssh
  cd /vagrant
  bin/setup-up-feature-usage
  bin/launch
```
2. Blow away ~/.nylas-mail (err backup your old one first)
3. Restart N1
4. Before logging in, edit `~/.nylas-mail/config.json`
   - set env to "local"
   - remove `thread-snooze` from the list of `disabledPlugins`
5. `cd /nylas-mail/src/k2` and run `npm start`
6. Restart N1 and create accounts & log in

Reviewers: khamidou, juan, halla

Reviewed By: halla

Differential Revision: https://phab.nylas.com/D3846
2017-02-07 15:46:57 -05:00
apm fix(rename): update nylas/N1 to nylas/nylas-mail Github references 2017-01-30 11:50:39 -08:00
build Update documentation with GitBook 2017-01-30 02:38:37 -08:00
docs Add built docs 2017-01-30 02:49:48 -08:00
docs_src Update docs config 2017-01-30 13:05:36 -08:00
dot-nylas Fix references for ~/.nylas to ~/.nylas-mail 2017-01-13 18:54:37 -08:00
flow-typed
internal_packages feat(usage): add new feature usage modal 2017-02-07 15:46:57 -05:00
keymaps
menus 🎨(rename): Update Nylas N1 to Nylas Mail 2017-01-12 12:05:44 -08:00
script Update docs config 2017-01-30 13:05:36 -08:00
spec feat(usage): Add a FeatureUsageStore and move Identity to the DB 2017-02-03 15:31:31 -08:00
spec_integration fix(rename): update nylas/N1 to nylas/nylas-mail Github references 2017-01-30 11:50:39 -08:00
src feat(usage): add new feature usage modal 2017-02-07 15:46:57 -05:00
static feat(usage): add new feature usage modal 2017-02-07 15:46:57 -05:00
.eslintrc
.gitignore Update docs config 2017-01-30 13:05:36 -08:00
.gitmodules Move old edgehill src/pro into K2/packages/nylas-private 2016-12-12 10:10:26 -05:00
.travis.yml Fix travis config 2017-02-02 17:48:40 -08:00
.watchmanconfig
appveyor.yml bump(appveyor): build stable branches 2017-02-03 10:19:15 -08:00
book.json Update docs config 2017-01-30 13:05:36 -08:00
CHANGELOG.md Update CHANGELOG.md 2017-02-07 09:42:34 -08:00
CONFIGURATION.md
CONTRIBUTING.md update(docs): Add note about Linux dependencies 2017-01-30 16:14:48 -08:00
ISSUE_TEMPLATE.md fix(rename): update nylas/N1 to nylas/nylas-mail Github references 2017-01-30 11:50:39 -08:00
keymap.json
LICENSE.md
package.json bump(version) 1.0.22 2017-02-07 09:01:06 -08:00
README.md Update README.md (#3255) 2017-02-02 21:24:43 -08:00

Nylas Mail - the open-source, extensible mail client

N1 Screenshot

Nylas Mail 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.

Build Status Slack Invite Button

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

Download Nylas Mail

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

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

Building the docs

Plugin SDK docs are available at https://nylas.github.io/nylas-mail/. Here's how you build them:

Until my patch gets merged, docs need to be built manually using mg's fork.

git clone git@github.com:grinich/gitbook.git

cd nylas-mail

./node_modules/.bin/gitbook alias ../gitbook latest

Then to actually build the docs:

script/grunt docs

./node_modules/.bin/gitbook --gitbook=latest build . ./_docs_output --log=debug --debug

rm -r docs_src/classes

If you want to preview the docs:

pushd ./_docs_output; python -m SimpleHTTPServer; popd

Just want to publish everything? There's a helper script that does it for you:

script/publish-docs

Configuration

You can configure Nylas Mail 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 Nylas Mail? Search for existing GitHub issues and join the conversation!