Abilitree - InTouch

InTouch is a mobile and web application enabling Abilitree staff and clients to communicate through groups.

This intouch-web repository is for administrator operations such as managing users, groups, and notifications.

Prerequisites

• Ruby on Rails
  • Rails overview and installation
  • Installation on MacOS
    • Follow the directions up to Check the Gem Manager
    • Skip until you see the command Install Bundler
    • Skip until Install Rails section

Version

• Ruby 2.4.1 (ruby -v)
• Rails 5.1.4 (rails -v)
• PostgreSQL 10.0 (psql --version)

Database Creation

• Install PostgreSQL
  • Installation
    • Mac users might have to brew install postgresql if the pg gem cannot be found

Keys File

• All of the app's secrets are stored in .env files for safe keeping
• Create the following files in the root directory following the example format
  • .env.test
  • .env.development
  • .env.staging
  • .env.production

Running the Application

• Run git clone https://github.com/osu-cascades/intouch-web.git in desired directory
• Run bundle install or exec bundle install inside of the cloned repository
• Run rake db:create:all
  • Note: The Postgres server installed above must be running
  • If you receive the error: FATAL: role "intouch" does not exist, you must create the role using psql -c 'create user intouch with superuser;' -U postgres
• Run rails db:migrate
• Run rails db:seed
• Run brew install node or brew reinstall node
• Run rails s or bundle exec rails s to start the application on http://localhost:3000/

Tests

• To run the tests, run rspec
• To view test coverage, open the coverage/index.html page
  • SimpleCov documentation

Heroku

• This application is hosted on Heroku in both a staging and production environment
  • Staging: https://abilitree-intouch-staging.herokuapp.com/
  • Production: https://abilitree-intouch.herokuapp.com/
• Set up the Heroku remotes
  • Staging: git remote add staging https://git.heroku.com/abilitree-intouch-staging.git
  • Production: git remote add production https://git.heroku.com/abilitree-intouch.git
• Deploy to Heroku
  • Staging: git push staging
  • Production: git push production
• Run Rails console
  • Staging: heroku run rails console --remote staging
  • Production: heroku run rails console --remote production
• View live logs
  • Staging: heroku logs --remote staging --tail
  • Production: heroku logs --remote production --tail

© 2019 Aaron Baker, Kyleen Gonzalez, Brad Cook, Hanna Bennett, Camron Fritz.