Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2024-09-20 15:26:06 +08:00
Code Issues Packages Projects Releases Wiki Activity
💌 A beautiful, fast and fully open source mail client for Mac, Windows and Linux.
4144 commits 31 branches 65 tags 142 MiB
C 49.4%
JavaScript 21.2%
TypeScript 14.6%
Fluent 7.3%
HTML 5.3%
Other 2.2%
Go to file
Evan Morikawa fcfae5d490 Fix references for ~/.nylas to ~/.nylas-mail 
Summary: Fix references to nylas-mail

Test Plan: manual

Reviewers: jackie, juan

Reviewed By: juan

Differential Revision: https://phab.nylas.com/D3674
2017-01-13 18:54:37 -08:00
apm 🎨(rename): Update Nylas N1 to Nylas Mail 2017-01-12 12:05:44 -08:00
build Fix references for ~/.nylas to ~/.nylas-mail 2017-01-13 18:54:37 -08:00
docs Fix references for ~/.nylas to ~/.nylas-mail 2017-01-13 18:54:37 -08:00
dot-nylas Fix references for ~/.nylas to ~/.nylas-mail 2017-01-13 18:54:37 -08:00
flow-typed rm(grim): We’re not using Grim for deprecations 2016-10-25 11:36:20 -07:00
internal_packages Fix references for ~/.nylas to ~/.nylas-mail 2017-01-13 18:54:37 -08:00
keymaps es6(composer): Composer extensions => ES2016 2016-10-27 17:28:36 -07:00
menus 🎨(rename): Update Nylas N1 to Nylas Mail 2017-01-12 12:05:44 -08:00
script fix(windows-build) bruteforce transient failure per http://help.appveyor.com/discussions/problems/5822-transient-build-failures-with-node-dependency-node-gyp 2017-01-10 11:54:49 -08:00
spec Fix references for ~/.nylas to ~/.nylas-mail 2017-01-13 18:54:37 -08:00
spec_integration Create a wrapper around legacy N1 APIs. 2017-01-09 15:18:43 -08:00
src Fix references for ~/.nylas to ~/.nylas-mail 2017-01-13 18:54:37 -08:00
static 🎨(rename): Update Nylas N1 to Nylas Mail 2017-01-12 12:05:44 -08:00
.eslintrc Update grunt tasks to lint and transpile es6 code using babel 2015-11-06 17:40:42 -08:00
.gitignore Create a new sync window. 2016-11-22 15:29:27 -08:00
.gitmodules Move old edgehill src/pro into K2/packages/nylas-private 2016-12-12 10:10:26 -05:00
.travis.yml fix(build) Temporarily remove tests 2017-01-06 09:58:55 -08:00
.watchmanconfig add watchman config file for fast fuzzy find 2016-12-05 16:23:48 -08:00
appveyor.yml Adding AppVeyor Slack notifications 2017-01-09 10:28:14 -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 🎨(rename): Update Nylas N1 to Nylas Mail 2017-01-12 12:05:44 -08: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 Bump to version 1.0 2017-01-13 13:28:39 -08:00
README.md Fix references for ~/.nylas to ~/.nylas-mail 2017-01-13 18:54:37 -08:00

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](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 Mail 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 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 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-mail/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.