Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2024-12-27 02:23:28 +08:00
Code Issues Projects Releases Packages Wiki Activity
💌 A beautiful, fast and fully open source mail client for Mac, Windows and Linux.
5531 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%
Find a file
Evan Morikawa 3c1c70e262 [client-app] use forked lerna for better npm logging
2017-03-06 15:35:56 -05:00
.ebextensions Fixes to Docker and better docs/debugging 2017-01-03 09:32:08 -08:00
arclib [local-private] move old edgehill src/pro into packages/local-private 2016-12-12 10:09:58 -05:00
packages [client-app] Fix build, add jasmine to iso-core deps 2017-03-06 11:36:03 -08:00
scripts [client-app] use forked lerna for better npm logging 2017-03-06 15:35:56 -05:00
.arcconfig Update .arcconfig to point to new repo 2017-02-16 14:15:19 -08:00
.arclint [*] Temporary fix for coffee linter in arc lint 2017-02-17 16:21:47 -08:00
.babelrc [client-app] symlink in babelrc and resolve links 2017-02-21 16:08:59 -05:00
.dockerignore [*] Make sure cloud deploy can access .babelrc 2017-02-22 12:09:14 -08:00
.eslintrc [none] Update .eslintrc 2017-03-01 16:57:03 -08:00
.gitignore [*] Change the symlink location for the isomorphic-core specs 2017-03-02 10:56:03 -08:00
.travis.yml [*] remove travs_wait now bootstrap more verbose 2017-03-06 14:13:12 -05:00
appveyor.yml [client-app] update appveyor 2017-03-03 14:22:38 -08:00
deploy-it [none] Make deploy-it support -h/--help 2017-02-28 15:42:23 -08:00
Dockerfile [dev, cloud-*] make Docker run plain npm install and conslidate deps 2017-02-21 14:33:00 -05:00
lerna.json [client-app] use forked lerna for better npm logging 2017-03-06 15:35:56 -05:00
package.json [client-app] use forked lerna for better npm logging 2017-03-06 15:35:56 -05:00
README.md [*] update and add READMEs to each package 2017-02-17 17:28:09 -08:00

README.md

Nylas Mail

This is a collection of all components required to run Nylas Mail.

  1. Isomorphic Core: Shared code across local client and cloud servers
  2. Client App: The main Electron app for Nylas Mail mirrored to open source repo.
  3. Client Sync: The local mailsync engine integreated in Nylas Mail
  4. Client Private Plugins: Private Nylas Mail plugins (like SFDC)
  5. Cloud API: The cloud-based auth and metadata APIs for N1
  6. Cloud Core: Shared code used in all remote cloud services
  7. Cloud Workers: Cloud workers for services like send later

See /packages for the separate pieces. Each folder in /packages is designed to be its own stand-alone repository. They are all bundled here for the ease of source control management.

Initial Setup for All Local & Cloud Services:

New Computer (Mac):

  1. Install Homebrew
  2. Install NVM & Redis brew install nvm redis
  3. Install Node 6 via NVM: nvm install 6

New Computer (Linux - Debian/Ubuntu):

  1. Install Node 6+ via NodeSource (trusted):
  2. curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
  3. sudo apt-get install -y nodejs
  4. Install Redis locally sudo apt-get install -y redis-server redis-tools benefit of letting us use subdomains.

Running Nylas Mail

  1. npm install (Only on fresh install and new packages)
  2. npm run start-client: Starts Electron app client
  3. npm run start-cloud: Starts cloud API locally