Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 2.61 KB

README.md

File metadata and controls

60 lines (40 loc) · 2.61 KB
Raw

Installation

install the heroku toolbelt to get foreman

git clone https://github.com/fellytone84/startup.git ~/.config
gem install consular 
gem install consular-osx    # if using Terminal
gem install consular-iterm  # if using iTerm
consular init               # this will create your .consularc

add one of the following lines to your .consularc:

require "consular/osx"      # if using Terminal    
require "consular/iterm"    # if using iTerm

configure the following variables in your .bash_profile or .zprofile:

# configure the paths below to match the location of each app.
# set each path starting from your ~/ directory

export SHORTSTACK_PATH="~/sites/shortstack"
export MESSAGING_PATH="~/sites/shortstack-messaging"
export TABSERVER_PATH="~/sites/shortstack-server"
export ADMIN_PATH="~/sites/shortstack-admin"
export DESIGNER_PATH="~/sites/shortstack-designer"

(after saving your bash profile, don't forget to restart your Terminal--I always forget about this)

Finally, to avoid any port conflicts, I setup the default configuration to look for a Procfile.dev in each app's root directory. Here are two of mine. The most notable difference is that I've hardcoded the port settings:

# ~/sites/shortstack/Procfile.dev        
shortstack: bundle exec unicorn -p 3000 -c ./config/unicorn.rb
shortstack-worker: bundle exec rake jobs:work

# ~/sites/shortstack-designer/Procfile.dev        
web: bundle exec unicorn -p 3002 -c ./config/unicorn.rb
log: tail -f -n 40 ./log/development.log

If you don't want to create a development procfile and would like to use the production Procfile instead, configure each consular script as follows:

in each script inside ~/.config/, replace

run "foreman start -f Procfile.dev"

with

run "foreman start"

Example Command Line Usage

consular list                                        # lists all available consular scripts
consular start shortstack                            # starts shortstack via foreman
consular start all                                   # starts all apps
consular start shortstack; consular start designer   # starts shortstack and designer

Command line tip: press Ctrl + r, then start typing the command or any part of the command that you are looking for. You'll see an autocomplete of a past command at your prompt. If you keep typing, you'll get more specific options. You can also press Ctrl + r again as many times as you want to, this goes back in your .bash_history to the previous matching command each time.