From b59c9f13e0d00adc9b76da3f3fc847b574efe770 Mon Sep 17 00:00:00 2001 From: Jim Vanderveen Date: Tue, 15 Mar 2016 06:15:20 -0700 Subject: [PATCH] (minor) Formatting Add a pinch of markdown --- README.md | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 64ec9eb..f0f9d8a 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,49 @@ These are the instructions to bring up the Rails environment for the dash-ingest codeline on your local machine. Software: +* ruby 2.1.2p95 +* Rails 3.2.19 -ruby 2.1.2p95 -Rails 3.2.19 Directories needed (create from top-level dash-ingest): +* uploads +* test_uploads +* log +* tmp/backup +* tmp/pids +* tmp/cache +* tmp/sockets -uploads -test_uploads -log -tmp/backup -tmp/pids -tmp/cache -tmp/sockets Modify as needed: +* config/database.yml +* config/datashare.yml +* config/merritt.yml +* deploy.rb (if doing deployment) -config/database.yml -config/datashare.yml -config/merritt.yml -deploy.rb (if doing deployment) Run Rake task for populating the institution table, only when deploying the app for the first time on a server: -$ RAILS_ENV=env bundle exec rake db:setup +`RAILS_ENV=env bundle exec rake db:setup` (replace 'env' with the name of the current environment). When running rails server, you have to specify the local environment like this: Why? The local is an environment that Mark created and I think it’s a workaround for user login problems since you can’t easily get a shibboleth login locally because of encryption, certificates and having to run some shib software. It basically automatically logs you in to the app with a fake user. (It’s the user with NULL email address in the database.) -$ RAILS_ENV=local rails server +`RAILS_ENV=local rails server` + Capistrano commands: (from your local if you have ssh on the server) For development branch the cap deploy command is: -$ Cap development deploy BRANCH="branch name" +`Cap development deploy BRANCH="branch name"` for other branches the cap deploy command is -$ Cap development deploy +`Cap development deploy` Then issue the restart command -$ Cap development deploy:restart +`Cap development deploy:restart` The test command is: -$ rspec -fd spec/features/ +`rspec -fd spec/features/`