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 behaviour. Getting them involved in mental health treatment is the key to recovery.
- Allows users to write about their experiences (Moments) similar to a blog and get feedback and support from their allies
- Create personalized categories and moods to organize Moments and Strategies
- Develop and share Strategies to solve problems and maintain healthy goals
- Keep track of medications and create alerts for them
- Create support groups whether online or offline and keep track of sessions
Current goals:
- Improve test coverage
- General clean up and tweaking of UI and UX, including language throughout the app
- More helpful and visual documentation to help familiarize contributors with the project
- Usability testing
Check our wiki for a summary of existing features!
Fork the repository, pick up an issue, or create an issue for a feature you would like to see. If would like to be added as a collaborator, email join.ifme@gmail.com.
Check out our Slack page if you have any questions, ideas, or concerns!
You can provide your feedback here!
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
This Code of Conduct is adapted from the Contributor Covenant, version 1.1.0, available at http://contributor-covenant.org/version/1/1/0/
The app uses Rails 4.2.5 and Ruby 2.3.0
The steps below should be straightforward for Linux and OSX users. Windows users please refer to this guide for tips on setup.
Check out http://www.postgresql.org/download/
Install via Homebrew
brew install postgresql
#####Linux
Bulid from the source using yum, apt-get, etc.
Install via graphical installer
After cloning the app on your local machine, in your terminal run the following commands in the /ifme directory
bundle install
If Ruby Bundle Symbol not found: _SSLv2_client_method (LoadError) is encountered, try running the following commands.
rvm get stable
rvm reinstall ruby
rvm gemset pristine
If using El Captian OS X 10.11+ and there are errors relating to libv8 and therubyracer, view the links below for help.
libv8:
therubyracer: http://stackoverflow.com/questions/33475709/install-therubyracer-gem-on-osx-10-11-el-capitan
On Windows, you may encounter an error like SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed. If this happens, download the CURL CA bundle and set the environment variable SSL_CERT_FILE to point to it.
If running bundle install on Mac OS X El Capitan v. 10.11.4 or later, please consult the following tickets for help with installing libv8 and therubyracer gems:
rubyjs/libv8#205 rubyjs/therubyracer#359
The two primary configuration files that you need to change are application.yml and smtp.yml. They are ignored in git to prevent accidentally checking in sensitive information.
Copy the sample files to create your own configuration files:
cp config/application.example.yml config/application.yml
cp config/smtp.example.yml config/smtp.yml
Mandatory: Run rake secret to generate a SECRET_KEY_BASE for config/application.yml. This is the only required configuration change.
The following are not mandatory, but are required if you would like to test/use these features:
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/application.yml.
Google APIs 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/application.yml. You'll need activate both the Google+ API and the Contacts API for Oauth and the Calendar API for Calendars.
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/application.yml`.
To get email notifications working, you must configure SMTP settings in config/smtp.yml.
development: {
address: '[insert address]',
port: '[insert port]',
authentication: 'plain',
user_name: '[insert email address]',
password: '[insert email password]',
domain: '[insert email domain]',
enable_starttls_auto: 'true'
}
test: {
address: '[insert address]',
port: '[insert port]',
authentication: 'plain',
user_name: '[insert email address]',
password: '[insert email password]',
domain: '[insert email domain]',
enable_starttls_auto: 'true'
}The following guide from Launch School is helpful.
Please do not test these with the Testing Accounts. Create new accounts with valid email addresses!
Create the developement and test databases:
bin/rake db:setup db:test:prepareStart the local server:
rails s
*** possible error for Linux users when attempting to run server:
PG::ConnectionBad (fe_sendauth: no password supplied ):
You may need to create a new PSQL user. Follow this guide to define a username and password.
To keep this information private, list PSQL_USERNAME and PSQL_PASSWORD under application.yml, then add username & password to database.yml:
development: &default
...
username: <%= ENV["PSQL_USERNAME"] %>
password: <%= ENV["PSQL_PASSWORD"] %>
rails db
Note that ifme_test is used when running unit tests
They have been created in 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
Always write unit tests for the changes you've made! If you see any missing unit tests, write them!
rspec
If you receive an error for having 'FATAL: database "ifme_test" does not exist', run the following.
bin/rake db:create db:migrate RAILS_ENV=test
Make a fork of the repository, create a new branch for every feature you are working on!
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 if me.
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 assets/contributors/firstname_lastname.png!
Find the source code for that page and submit a pull request with your story!
Please post any bugs, questions, or ideas on our issues page. If you prefer not to post publicly, you can post here.
For bugs, please list the reproduction steps and specify if the bug was prodcued locally or on production.
The source code is licensed under the Apache License. For more information see http://www.apache.org/licenses/ or LICENSE.txt.