/ifme

Open source app to share mental health experiences with loved ones

Primary LanguageRubyGNU Affero General Public License v3.0AGPL-3.0

CircleCI Code Climate

if me

if me is a community for mental health experiences that encourages people to share their personal stories with trusted allies. Trusted allies are the people we interact with on a daily basis, including friends, family members, co-workers, teachers, and mental health workers.

Dealing with mental health is what makes us human. But for a lot of us, it's a struggle to be open about it. Not everyone is a counsellor or therapist. The people who we interact with everyday shape our emotions and behavior. Getting them involved in mental health treatment is the key to recovery.

Read about our project goals and how to contribute (not just as a developer) here.

We use the wonderful Contributor Covenant for our code of conduct. Please read it before joining our project.

Table of Contents

Installation

The app uses Ruby 2.3.4 and Rails 4.2.9. Please stick to these versions.

The steps below should be straightforward for Linux and macOS users. Windows users please refer to this guide for tips on setup. We have documentation for Debian GNU/Linux users.

Commons errors faced during installation are documented in this guide.

1) Install Ruby on Rails

Ruby on Rails

If you do not have Rails, use this handy guide.

If you're updating an existing installation through RVM or rbenv, continue to (A) or (B).

Option (A) RVM

Assuming you have RVM installed, update to the latest version

rvm get stable --autolibs=enable

Close and re-open the terminal window

rvm install ruby-2.3.4

Check that Ruby has been updated by running ruby -v.

Option (B) rbenv

Follow instructions for updating rbenv at the project's GitHub. Make sure you also upgrade ruby-build if you used Homebrew to install rbenv.

Run the following to install Ruby 2.3.4:

rbenv install 2.3.4

Once you have cloned the project, set the local Ruby version to 2.3.4:

cd ifme
rbenv local 2.3.4

Gems: After updating or installing Ruby

Update the gem manager by running gem update --system.

Update your gems by running gem update.

If you are missing bundler and nokogiri, please install them

gem install bundler

gem install nokogiri

Make a gemset for the specific Ruby on Rails version through RVM or rbenv. Continue to (A) or (B).

Option (A) RVM

rvm use ruby-2.3.4@rails4.2.9 --create

Option (B) rbenv

rbenv-gemset

Updating An Existing Rails Installation

gem install rails --version=4.2.9

Restart your terminal (or open a new tab)

Check that Rails has been updated by running rails -v.

2) Install Postgres

Postgres

After installing Postgres, if you are asked to create a new user, please follow these instructions.

A. macOS

Install via Homebrew

brew install postgresql

then start the postgres server:

postgres -D /usr/local/var/postgres

For more information, follow this postgresql guide for a more detailed setup

B. Linux

Build from the source using yum, apt-get, etc. If you already have Postgres installed, please update it.

C. Windows

Install via graphical installer

Install Gems

After cloning the app on your local machine, in your terminal run the following command in the /ifme directory

bundle install

Configuration Files

Mandatory

Mandatory

There are three config files: config/env/test.env, config/env/development.env, and config/env/production.env. To run the app locally, you should modify test.env and development.env. They are ignored in git to prevent accidentally committing sensitive information.

Copy the sample files to create your own configuration files:

cp config/env/test.example.env config/env/test.env cp config/env/development.example.env config/env/development.env

Run rake secret twice to generate values for SECRET_KEY_BASE and DEVISE_SECRET_KEY. The values in test.env and development.env can be the same.

BE CAREFUL: The secret should be in the test.env and development.env NOT the config/env/test.example.env or config/env/development.example.env files. The example files are not ignored by git.

Optional

Optional

The following are not mandatory, but are required if you would like to test/use these features.

Pusher

Pusher is used in-app notifications. If you would like to use this feature in your local environment, please create your own account, generate keys, and update PUSHER_APP_ID, PUSHER_KEY, PUSHER_SECRET in config/env/test.env and config/env/development.env.

Google OAuth 2.0 IDs

Google OAuth 2.0 IDs is used for OAuth (Sign in with Google) and Calendars (refill dates for Medications). If you would like to use this feature in your local environment, please create your own account, generate keys, and update GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET in config/env/test.env and config/env/development.env. You'll need to activate both the Google+ API and the Contacts API for OAuth, and the Calendar API for Calendars. Under the credentials tab, make sure to add the Authorized redirect URI as http://localhost:3000/users/auth/google_oauth2/callback. Note, you may have to hit the Save button twice for this to take effect.

Google API

Google API is used for location autocomplete, specifically the Maps JavaScript API (which needs to be activated). If you would like to use this feature in your local environment, please create your own account, generate keys, and update GOOGLE_API_KEY in config/env/test.env and config/env/development.env.

Cloudinary

Cloudinary is used to store profile pictures. If you would like to use this feature in your local environment, please create your own account, generate keys, and update CLOUDINARY_CLOUD_NAME, CLOUDINARY_API_KEY, and CLOUDINARY_API_SECRET in config/env/test.env and config/env/development.env.

If want to generate static images through the Cloudinary CDN, run heroku run rake cloudinary:sync_static.

Email Notifications

To get email notifications working, you must configure SMTP settings in config/env/test.env and config/env/development.env.

The following guide from Launch School is helpful.

Please do not test these with the Testing Accounts. Create new accounts with valid email addresses!

If you want to test out scheduled emails, run the following commands:

bundle exec rake scheduler:send_take_medication_reminders

bundle exec rake scheduler:send_refill_reminders

bundle exec rake scheduler:send_perform_strategy_reminders

bundle exec rake scheduler:send_meeting_reminders

Letter Opener

The gem letter_opener enables test e-mails to be sent without actually sending an e-mail accidentally to someone through SMTP.

You can disable this gem when you deploy the app by commenting it out.

# gem "letter_opener", :group => :development

You can read more about this gem here.

Running the App Locally

Create the development and test databases:

bin/rake db:setup db:test:prepare

Run rake slugs:slugify to update existing entries in the database with slugs (e.g. moments/fun-slug)

Start the local server:

rails s

To view the app, go to http://localhost:3000.

Docker

Docker

Assuming Docker is setup, you can start the server using

docker-compose up

or open a shell using

docker-compose -f docker-compose.yml -f docker-compose.test.yml run --rm app bash
Vagrant

Vagrant

Assuming Vagrant is setup, you can add the following line to your Vagrantfile. Make sure to add it exactly as below - with : and not quotes, or it may not work properly.

config.vm.network :forwarded_port, guest: 3000, host: 3000

Rails 4.2 binds to 127.0.0.1, so you may need to specify 0.0.0.0 when starting the server for localhost.

bin/rails server -b 0.0.0.0

Accessing the Database

rails db

Note that ifme_test is used when running unit tests

Testing Accounts

They have been created in db/seeds.rb. Feel free to modify seeds.rb to help to your development needs! You can also test with Google accounts.

Email: test1@example.com
Password: password99

Email: test2@example.com
Password: password99

Email: test3@example.com
Password: password99

Testing Guidelines

We are using Selenium for web browser automation, so you will need to install a version of Firefox that is compatible with Selenium, which is often not the latest build. Firefox 46 is guaranteed to work (just make sure you don't update it).

Always write tests for the changes you've made! If you see any missing tests, write them!

Rspec for Ruby

rspec

Jasmine for JavaScript

Make sure PhantomJS is installed locally, either through their website or by running brew install phantomjs.

GUI Version

In a new terminal window, run rake jasmine.

To view the test results, go to http://localhost:8888.

Command Line Version

rake jasmine:ci

Static Code Analysis

JSHint

bundle exec rake jshint

Committing Work

Make a fork of the repository, create a new branch for every feature you are working on! Always make pull requests!

If you've been added as a collaborator to the repository, please do not push unless the commit you are making is trivial i.e. doesn't require a code review. If you're unsure about this, please ask!

Everyone is encouraged to participate in code reviews, so please do so!

Style Guide

  • We use 2 space indentation.
  • We use snakecase for Ruby files and id/class names in HTML.
  • We use camelcase for JS files.
  • Make sure you run the test suite locally before you commit, don't rely on CircleCI to do that for you.
  • Make sure commit messages are clear and concise are tagged with the issue number e.g. "[#99] Fixes some sample issue".
  • Make sure pull requests reference the corresponding issue.
  • Make sure any issues or pull requests that are UI/UX focused have appropriate screenshots.
  • As a pull request (PR) reviewer, if you think the PR is good to go (including passing tests) make sure to comment with LGTM (looks good to me). You can either merge it yourself or tell the PR creator to do it themselves.
  • If you add or modify a model, please run annotate to update the schema comments and rake db:drop db:create db:migrate; rake db:schema:load to update db/schema.rb.

Contributor Blurb

In the spirit of open communication and community, we highly recommend that new contributors write a blurb on themselves, what mental health means to them, and why they are part of the project. Please write this in first person.

This also helps people to familiarize themselves with the code base! The live contributors page can be found here. Contributor images must be at least 800x800 px and be in .jpg or .png format. Please save the image as app/assets/images/contributors/firstname_lastname.png! Add your blurb to doc/pages/blurbs.json.

If you've contributed to the project but do not want to write a blurb, please add your name and desired social media link to doc/pages/contributors.json.

Tracking Issues

Please post any bugs, questions, or ideas on our issues page. If you prefer not to post publicly, you can post here.

Labelling Issues

If you create an issue, please tag it with the appropriate label. We use enhancement for feature work and bug for bugs. If you created an issue and are not working on it, please tag it as help wanted. The majority of technical contributors are up and coming developers, so be sure to tag appropriate issues as newbiefriendly! If you are working on an issue, please assign it to yourself. If you are unable to do so, please let us know and we will add you as a collaborator.

For bugs, please list the reproduction steps and specify if the bug was produced locally or on production. Please also mention what OS and browser you are using.

License

The source code is licensed under GNU AGPLv3. For more information see http://www.gnu.org/licenses/agpl-3.0.txt or LICENSE.txt.