Mailspring/README.md

# Nylas Mail

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

1. [**Isomorphic Core**](https://github.com/nylas/nylas-mail-all/tree/master/packages/isomorphic-core): Shared code across local client and cloud servers
1. [**Client App**](https://github.com/nylas/nylas-mail-all/tree/master/packages/client-app): The main Electron app for Nylas Mail
   mirrored to open source repo.
1. [**Client Sync**](https://github.com/nylas/nylas-mail-all/tree/master/packages/client-sync): The local mailsync engine integreated in Nylas Mail
1. [**Client Private Plugins**](https://github.com/nylas/nylas-mail-all/tree/master/packages/client-private-plugins): Private Nylas Mail plugins (like SFDC)
1. [**Cloud API**](https://github.com/nylas/nylas-mail-all/tree/master/packages/cloud-api): The cloud-based auth and metadata APIs for N1
1. [**Cloud Core**](https://github.com/nylas/nylas-mail-all/tree/master/packages/cloud-core): Shared code used in all remote cloud services
1. [**Cloud Workers**](https://github.com/nylas/nylas-mail-all/tree/master/packages/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](http://brew.sh/)
1. Install [NVM](https://github.com/creationix/nvm) & Redis `brew install nvm redis`
1. Install Node 6 via NVM: `nvm install 6`

## New Computer (Linux - Debian/Ubuntu):

1. Install Node 6+ via NodeSource (trusted):
  1. `curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -`
  1. `sudo apt-get install -y nodejs`
1. 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)
1. `npm run start-client`: Starts Electron app client
1. `npm run start-cloud`: Starts cloud API locally
[client-*] Rename packages folders and update readme 2017-02-17 05:31:37 +08:00			`# Nylas Mail`
Create README.md 2016-06-21 03:19:01 +08:00
[client-*] Rename packages folders and update readme 2017-02-17 05:31:37 +08:00			`This is a collection of all components required to run Nylas Mail.`
Readme updates 2016-11-29 06:13:23 +08:00
[client-*] Rename packages folders and update readme 2017-02-17 05:31:37 +08:00			`1. [Isomorphic Core](https://github.com/nylas/nylas-mail-all/tree/master/packages/isomorphic-core): Shared code across local client and cloud servers`
			`1. [Client App](https://github.com/nylas/nylas-mail-all/tree/master/packages/client-app): The main Electron app for Nylas Mail`
			`mirrored to open source repo.`
			`1. [Client Sync](https://github.com/nylas/nylas-mail-all/tree/master/packages/client-sync): The local mailsync engine integreated in Nylas Mail`
			`1. [Client Private Plugins](https://github.com/nylas/nylas-mail-all/tree/master/packages/client-private-plugins): Private Nylas Mail plugins (like SFDC)`
			`1. [Cloud API](https://github.com/nylas/nylas-mail-all/tree/master/packages/cloud-api): The cloud-based auth and metadata APIs for N1`
			`1. [Cloud Core](https://github.com/nylas/nylas-mail-all/tree/master/packages/cloud-core): Shared code used in all remote cloud services`
			`1. [Cloud Workers](https://github.com/nylas/nylas-mail-all/tree/master/packages/cloud-workers): Cloud workers for services like send later`
Readme updates 2016-11-29 06:13:23 +08:00
			See `/packages` for the separate pieces. Each folder in `/packages` is
fix typo 2017-01-25 05:57:46 +08:00			`designed to be its own stand-alone repository. They are all bundled here`
Readme updates 2016-11-29 06:13:23 +08:00			`for the ease of source control management.`

			`# Initial Setup for All Local & Cloud Services:`
Add procfile.dev with external redis launcher 2016-06-22 08:44:09 +08:00
Added Dockerrun.aws.json 2016-07-08 03:08:48 +08:00			`## New Computer (Mac):`
Add procfile.dev with external redis launcher 2016-06-22 08:44:09 +08:00
Added Dockerrun.aws.json 2016-07-08 03:08:48 +08:00			`1. Install [Homebrew](http://brew.sh/)`
[] move to monorepo [] update babel [client-app] remove flow-typed [client-app] Move build/package.json to main package.json [client-app] remove spec_integration [client-app] fix babel support Add client-private-plugins package.json [client-app] add node_modules to global path for private-plugins Move client-sync dependencies to client-app root fix electron rebuild [*] moved to monorepo Summary: App now runs in monorepo Test Plan: npm test Reviewers: juan, mark, khamidou, halla, spang Differential Revision: https://phab.nylas.com/D3947 2017-02-17 06:53:20 +08:00			1. Install [NVM](https://github.com/creationix/nvm) & Redis `brew install nvm redis`
Readme updates 2016-11-29 06:13:23 +08:00			1. Install Node 6 via NVM: `nvm install 6`
Create README.md 2016-06-21 03:19:01 +08:00
Add Linux setup instructions to README.md 2016-07-12 09:36:08 +08:00			`## New Computer (Linux - Debian/Ubuntu):`
Readme updates 2016-11-29 06:13:23 +08:00
Add Linux setup instructions to README.md 2016-07-12 09:36:08 +08:00			`1. Install Node 6+ via NodeSource (trusted):`
			1. `curl -sL https://deb.nodesource.com/setup_6.x \| sudo -E bash -`
			1. `sudo apt-get install -y nodejs`
Readme updates 2016-11-29 06:13:23 +08:00			1. Install Redis locally `sudo apt-get install -y redis-server redis-tools`
Readme fixes 2016-07-09 00:12:11 +08:00			`benefit of letting us use subdomains.`
[] move to monorepo [] update babel [client-app] remove flow-typed [client-app] Move build/package.json to main package.json [client-app] remove spec_integration [client-app] fix babel support Add client-private-plugins package.json [client-app] add node_modules to global path for private-plugins Move client-sync dependencies to client-app root fix electron rebuild [*] moved to monorepo Summary: App now runs in monorepo Test Plan: npm test Reviewers: juan, mark, khamidou, halla, spang Differential Revision: https://phab.nylas.com/D3947 2017-02-17 06:53:20 +08:00
			`# Running Nylas Mail`

			1. `npm install` (Only on fresh install and new packages)
			1. `npm run start-client`: Starts Electron app client
[*] update and add READMEs to each package Summary: Adding READMEs for easy and helpful browsing on GitHub. Also add missing script and `--interpreter` flag Test Plan: Run new launch commands Reviewers: mark, spang, juan, halla Reviewed By: spang, juan, halla Differential Revision: https://phab.nylas.com/D3971 2017-02-18 09:28:09 +08:00			1. `npm run start-cloud`: Starts cloud API locally