Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2024-12-26 10:00:50 +08:00
Code Issues Projects Releases Packages Wiki Activity

fix(readme): minor readme changes

Browse source
This commit is contained in:
Evan Morikawa 2016-11-21 18:18:09 -08:00
parent 45d682c957
commit b13aa32f60
2 changed files with 9 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -1,14 +1,12 @@
# K2 - Sync Engine Experiment # K2 - The local sync engine for Nylas N1
# Initial Setup: # Initial Setup:
## New Computer (Mac): ## New Computer (Mac):
1. Install [Homebrew](http://brew.sh/) 1. Install [Homebrew](http://brew.sh/)
2. Install [VirtualBox 5+](https://www.virtualbox.org/wiki/Downloads)
3. Install [Docker for Mac](https://docs.docker.com/docker-for-mac/)
4. Install [NVM](https://github.com/creationix/nvm) `brew install nvm` 4. Install [NVM](https://github.com/creationix/nvm) `brew install nvm`
5. Install Node 6+ via NVM: `nvm install 6` 5. Install Node 6 via NVM: `nvm install 6`
6. Install Redis locally `brew install redis` 6. Install Redis locally `brew install redis`
## New Computer (Linux - Debian/Ubuntu): ## New Computer (Linux - Debian/Ubuntu):
@ -17,27 +15,11 @@
1. `sudo apt-get install -y nodejs` 1. `sudo apt-get install -y nodejs`
2. Install Redis locally `sudo apt-get install -y redis-server redis-tools` 2. Install Redis locally `sudo apt-get install -y redis-server redis-tools`
## New to AWS:
1. Install [Elastic Beanstalk CLI](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-install.html#eb-cli3-install-osx): `sudo pip install awsebcli`
1. On Linux, you may need to install Python 3's pip via `sudo apt-get install python3-pip` and then run `pip3 install --user awsebcli`. This installs to your home directory and you need to have `~/.local/bin` in your $PATH.
2. Install [AWS CLI](https://aws.amazon.com/cli/): `brew install awscli` on Mac and `pip install --user awscli` on Linux.
1. Add your AWS IAM Security Credentials to `aws configure`.
1. These are at Console Home -> IAM -> Users -> {{Your Name}} -> Security
Credentials. Note that your private key was only shown unpon creation. If
you've lost your private key you have to deactivate your old key and
create a new one.
3. Get the K2 team private SSH key. (Ignore this when we have a Bastion Host). Ask someone on K2 for a copy of the private SSH key. Copy it to your ~/.ssh folder.
1. `chmod 400 ~/.ssh/k2-keypair.pem`
1. `ssh i ~/.ssh/k2-keypair.pem some-ec2-box-we-own.amazonaws.com`
4. Connect to Elastic Beanstalk instances: `eb init`. Select correct region. Select correct application.
# Developing Locally: # Developing Locally:
``` ```
npm run start npm install
npm run logs npm start
npm run stop
``` ```
We use [pm2](http://pm2.keymetrics.io/) to launch a variety of processes We use [pm2](http://pm2.keymetrics.io/) to launch a variety of processes

10
package.json
View file

@ -1,7 +1,7 @@
{ {
"name": "k2", "name": "k2",
"version": "0.0.1", "version": "0.0.2",
"description": "k2", "description": "The local sync engine for Nylas N1",
"main": "", "main": "",
"dependencies": { "dependencies": {
"bunyan": "1.8.0", "bunyan": "1.8.0",
@ -41,13 +41,13 @@
"url": "git+https://github.com/nylas/K2.git" "url": "git+https://github.com/nylas/K2.git"
}, },
"author": "Nylas", "author": "Nylas",
"license": "ISC", "license": "proprietary",
"bugs": { "bugs": {
"url": "https://github.com/nylas/K2/issues" "url": "https://github.com/nylas/K2/issues"
}, },
"homepage": "https://github.com/nylas/K2#readme", "homepage": "https://github.com/nylas/K2#readme",
"engines": { "engines": {
"node": "6.2.2", "node": "6.9.1",
"npm": "3.9.5" "npm": "3.10.8"
} }
} }