Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
app
 
 
 
 
db
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Envelope

Build Status

Envelope is a web-based email management solution built with Ruby on Rails. We are currently in the process of moving to a JS Framework (Spine). Envelope began as a CMU Information Systems project by Dom Cerminara, Elizabeth Li, Seth Vargo, and Xun Wang.

Quick Start

On a Mac

  1. Clone the project

    git clone git@github.com:envelopeapp/envelope.git && cd envelope

  2. Run script/mac:

     ./script/mac
    

I highly encourage you to look at the script for you personal sanity. In short, it:

  1. Install homebrew

  2. Install elasticsearch

  3. Install mongodb

  4. Bundle the gems

  5. (optional) Seed the database

     GMAIL_USERNAME=[YOUR GMAIL USERNAME] GMAIL_PASSWORD=[YOUR GMAIL PASSWORD] bundle exec rake db:seed
    
  6. Fire up the application

     bundle exec foreman start
    

With Vagrant

Envelope is packaged with vagrant and is available for download. It is currently an ubuntu precise64 box packaged with all the necessary dependencies already installed.

  1. Install vagrant

  2. Clone the project

     git clone git@github.com:envelopeapp/envelope.git && cd envelope
    
  3. Install the envelope base box:

     vagrant box add envelope http://github.com/downloads/envelopeapp/envelope/base.box
    
  4. Initialize the box:

     vagrant init envelope
    
  5. Boot up the VM

     vagrant up
    
  6. You should now be able to ssh into the Ubuntu box:

     vagrant ssh
    
  7. Change into the /vagrant bootstrap the application

     ./script/ubuntu
    
  8. (optional) Seed the database

     GMAIL_USERNAME=[YOUR GMAIL USERNAME] GMAIL_PASSWORD=[YOUR GMAIL PASSWORD] bundle exec rake db:seed
    
  9. Fire up the application

     bundle exec foreman start
    

Note It is highly recommended that you adjust the VirutalBox settings and give the box at least 2GB of RAM!

Structure

Envelope has 4 major components:

For more information, such as Installation or Scaling, please see the Wiki.

About

Envelope is a web-based email management tool

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published