Skip to content

Commit

Permalink
Merge branch 'master' into stable
Browse files Browse the repository at this point in the history
  • Loading branch information
emorikawa committed Nov 22, 2016
2 parents ee1322a + 3740403 commit b127782
Show file tree
Hide file tree
Showing 267 changed files with 4,586 additions and 47,733 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,5 @@ internal_packages/open-tracking
internal_packages/send-later
internal_packages/send-reminders
internal_packages/thread-sharing
/dist
/dump.rdb
4 changes: 3 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,13 @@ before_script:
sh -e /etc/init.d/xvfb start;
fi

script: script/cibuild
script:
- script/bootstrap && npm test && script/grunt ci --stack --no-color

cache:
directories:
- node_modules
- apm/node_modules
- build/node_modules

# The NYLAS_GITHUB_OAUTH_TOKEN is overriden by build/resources/certs/set_unix_env.sh
Expand Down
33 changes: 23 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Filing an Issue

Thanks for checking out N1! If you have a feature request, be sure to check out the [open source roadmap](http://trello.com/b/hxsqB6vx/n1-open-source-roadmap). If someone has already requested the feature you have in mind, you can upvote the card on Trello—to keep things organized, we often close feature requests on GitHub after creating Trello cards.
Thanks for checking out N1! If you have a feature request, be sure to check out the [open source roadmap](http://trello.com/b/hxsqB6vx/n1-open-source-roadmap). If someone has already requested
the feature you have in mind, you can upvote the card on Trello—to keep things organized, we
often close feature requests on GitHub after creating Trello cards.

If you've found a bug, try searching for similars issue before filing a new one. Please include the version of N1 you're using, the platform you're using (Mac / Windows / Linux), and the type of email account. (Gmail, Outlook 365, etc.)
If you've found a bug, try searching for similars issue before filing a new one. Please include
the version of N1 you're using, the platform you're using (Mac / Windows / Linux), and the
type of email account. (Gmail, Outlook 365, etc.)

# Contributing to N1

Expand All @@ -14,7 +18,16 @@ engine](https://github.com/nylas/sync-engine) repository.

### Getting Started

First, clone and build N1 from source:
Before you get started, make sure you've installed the following dependencies.
N1's build scripts and tooling use modern JavaScript features and require:

- Node 6.0 or above with npm3
- python 2.7

Linux users on Debian 8 and Ubuntu 15.04 onward must also install libgcrypt11
and gnome-keyring.

Next, clone and build N1 from source:

git clone https://github.com/nylas/N1.git
cd N1
Expand All @@ -24,18 +37,13 @@ Read the [getting started guides](https://nylas.github.io/N1/getting-started/).

**Building Nylas on Windows? See the [Windows instructions.](https://github.com/nylas/N1/blob/master/docs/Windows.md)**

Linux users on Debian 8 and Ubuntu 15.04 onward must also install libgcrypt11, which Electron depends on.

### Running N1

./N1.sh --dev --enable-logging

Once the app boots, you'll be prompted to enter your email credentials.

npm start

### Testing N1

./N1.sh --test --enable-logging
npm test

This will run the full suite of automated unit tests. We use [Jasmine 1.3](http://jasmine.github.io/1.3/introduction.html).

Expand All @@ -44,6 +52,11 @@ It runs all tests inside of the `/spec` folder and all tests inside of

You may skip certain tests (temporarily) with `xit` and `xdescribe`, or focus on only certain tests with `fit` and `fdescribe`.

### Linting N1

N1 lints clean against eslint, coffeelint, csslint, lesslint, and our own internal
tool, nylaslint. To run the linters, just run `npm run lint`.

### Creating binaries

Once you've checked out N1 and run `script/bootstrap`, you can create a packaged
Expand Down
23 changes: 0 additions & 23 deletions N1.sh

This file was deleted.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,12 @@ The Nylas N1 user interface is styled using CSS, which means it's easy to modify
- [Gmail](https://github.com/dregitsky/n1-gmail-theme)
- [Darkish](https://github.com/dyrnade/N1-Darkish)

#### To install 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
5. Select `Change Theme...` from the top level menu, and you'll see the newly installed theme. That's it!
5. 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](https://github.com/nylas/N1-theme-starter)!
Expand Down
5 changes: 2 additions & 3 deletions apm/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
N1 uses [apm](https://github.com/atom/apm) to build packages instead of `npm`.
This is because packages need to be compiled against Chrome's headers to work
properly with Electron.
N1 ships a copy of [apm](https://github.com/atom/apm) to build packages
when users choose to install them. This won't be true much longer.
16 changes: 10 additions & 6 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@ branches:
- stable
- /ci-build\/.*/

test: off

# We deploy via grunt publish-nylas-build instead of AppVeyor
deploy: off

# We need to only clone the main module because our submodule requires the
# encrypted ssh key to access submodules
clone_depth: 1
Expand All @@ -43,7 +38,13 @@ install:
}
build_script:
- ps: .\script\cibuild.ps1
- cmd: script\bootstrap.cmd

test_script:
- ps: npm test

deploy_script:
- cmd: script\grunt.cmd ci --stack --no-color

environment:
matrix:
Expand All @@ -55,5 +56,8 @@ environment:
secure: 48VSzDtdBd52Xlo3TZ1NeR1yRRrZ3AU6Px5XjD5RDp44cFU5GYVspecGqX6DGCV7i0D7nldGMyEbXNrjM1t1Kw==

cache:
- node_modules -> package.json
- apm\node_modules -> apm\package.json
- build\node_modules -> build\package.json
- '%USERPROFILE%\.nylas\.apm'
- '%USERPROFILE%\.npm'
Loading

0 comments on commit b127782

Please sign in to comment.