Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2024-12-29 20:04:59 +08:00
Code Issues Projects Releases Packages Wiki Activity
💌 A beautiful, fast and fully open source mail client for Mac, Windows and Linux.
219 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
Annie 5868fb5207 make changes requested before pull
2016-07-11 13:48:00 -07:00
packages make changes requested before pull 2016-07-11 13:48:00 -07:00
.dockerignore Dockerfile successfully building ping endpoint 2016-07-07 12:10:01 -07:00
.env Commit .env to fix dev environment 2016-06-27 13:29:13 -07:00
.eslintrc Add sync worker error handling 2016-06-27 16:03:38 -07:00
.gitignore Re-add .elasticbeanstalk to gitignore 2016-07-07 12:13:27 -07:00
Dockerfile Update dockerfile to start with env variable 2016-07-07 16:32:46 -07:00
lerna.json Upgrade lerna 2016-07-06 13:51:17 -07:00
package.json package json fixed 2016-07-07 16:08:19 -07:00
pm2-dev.yml Readme fixes 2016-07-08 12:12:11 -04:00
pm2-prod-api.yml Add dashboard pm2 config 2016-07-07 17:07:19 -07:00
pm2-prod-dashboard.yml Add dashboard pm2 config 2016-07-07 17:07:19 -07:00
pm2-prod-sync.yml Switch to PM2 for dev + prod 2016-07-07 15:25:45 -07:00
README.md Readme fixes 2016-07-08 12:12:11 -04:00

README.md

K2 - Sync Engine Experiment

Initial Setup:

New Computer (Mac):

  1. Install Homebrew
  2. Install VirtualBox 5+
  3. Install Docker for Mac
  4. Install NVM brew install nvm
  5. Install Node 6+ via NVM: nvm install 6
  6. Install Redis locally brew install redis

New to AWS:

  1. Install Elastic Beanstalk CLI: sudo pip install awsebcli
  2. Install AWS CLI: brew install awscli
  3. Add your AWS IAM Security Credentials to aws configure.
  4. 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.
  5. 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.
  6. chmod 400 ~/.ssh/k2-keypair.pem
  7. ssh i ~/.ssh/k2-keypair.pem some-ec2-box-we-own.amazonaws.com
  8. Connect to Elastic Beanstalk instances: eb init. Select correct region. Select correct application.

Developing Locally:

npm start

We use pm2 to launch a variety of processes (sync, api, dashboard, processor, etc).

You can see the scripts that are running and their arguments in /pm2-dev.yml

To test to see if the basic API is up go to: http://lvh.me:5100/ping. You should see pong.

lvh.me is a DNS hack that redirects back to 127.0.0.1 with the added benefit of letting us use subdomains.

Deploying