[client-*] Rename packages folders and update readme
19
README.md
|
@ -1,12 +1,15 @@
|
|||
# K2 - Local Sync Engine & Cloud Services for Nylas Mail
|
||||
# Nylas Mail
|
||||
|
||||
This is a collection of all sync and cloud components required to run N1.
|
||||
This is a collection of all components required to run Nylas Mail.
|
||||
|
||||
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 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
|
||||
|
@ -20,6 +23,7 @@ for the ease of source control management.
|
|||
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`
|
||||
1. `npm install`
|
||||
|
||||
## New Computer (Linux - Debian/Ubuntu):
|
||||
|
||||
|
@ -28,3 +32,4 @@ for the ease of source control management.
|
|||
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.
|
||||
1. `npm install`
|
||||
|
|
Before Width: | Height: | Size: 8 KiB After Width: | Height: | Size: 8 KiB |
Before Width: | Height: | Size: 521 B After Width: | Height: | Size: 521 B |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
Before Width: | Height: | Size: 2.8 KiB After Width: | Height: | Size: 2.8 KiB |
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
Before Width: | Height: | Size: 161 KiB After Width: | Height: | Size: 161 KiB |
Before Width: | Height: | Size: 654 KiB After Width: | Height: | Size: 654 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |