Mailspring/README.md

31 lines
1.5 KiB
Markdown
Raw Normal View History

2016-11-29 06:13:23 +08:00
# K2 - Local Sync Engine & Cloud Services for Nylas N1
2016-06-21 03:19:01 +08:00
2016-11-29 06:13:23 +08:00
This is a collection of all sync and cloud components required to run N1.
1. [**Cloud API**](https://github.com/nylas/K2/tree/master/packages/cloud-api): The cloud-based auth and metadata APIs for N1
1. [**Cloud Core**](https://github.com/nylas/K2/tree/master/packages/cloud-core): Shared code used in all remote cloud services
1. [**Cloud Workers**](https://github.com/nylas/K2/tree/master/packages/cloud-workers): Cloud workers for services like send later
1. [**Isomorphic Core**](https://github.com/nylas/K2/tree/master/packages/isomorphic-core): Shared code across local client and cloud servers
1. [**Local Sync**](https://github.com/nylas/K2/tree/master/packages/local-sync): The local mailsync engine integreated in Nylas N1
See `/packages` for the separate pieces. Each folder in `/packages` is
designed to be its own stand-alone repositoriy. They are all bundled here
for the ease of source control management.
# Initial Setup for All Local & Cloud Services:
2016-07-08 03:08:48 +08:00
## New Computer (Mac):
2016-07-08 03:08:48 +08:00
1. Install [Homebrew](http://brew.sh/)
2016-11-29 06:13:23 +08:00
1. Install [NVM](https://github.com/creationix/nvm) `brew install nvm`
1. Install Node 6 via NVM: `nvm install 6`
1. Install Redis locally `brew install redis`
2016-06-21 03:19:01 +08:00
## New Computer (Linux - Debian/Ubuntu):
2016-11-29 06:13:23 +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`
2016-11-29 06:13:23 +08:00
1. Install Redis locally `sudo apt-get install -y redis-server redis-tools`
2016-07-09 00:12:11 +08:00
benefit of letting us use subdomains.