Code Monkey home page Code Monkey logo

ifme's Introduction

if me

A community for mental health experiences

Table of Contents

  1. Goals
  2. Getting Involved
  3. Getting Started
  4. Testing Accounts
  5. Committing Work
  6. License

Goals

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.

The goal is to create a platform that:

  • Allows users to write about their experiences (Triggers) similar to a blog and get feedback and support from their allies
  • Create personalized categories and moods to organize Triggers 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
  • Create introductory user survey based on user's current mood to personalize writing prompts in Triggers
  • 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

Getting Involved

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 [email protected].

Check out our Slack page if you have any questions, ideas, or concerns!

Contributor Code of Conduct

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/

Getting Started

Installing Programs

The steps below should be straightforward for Linux and OSX users. Windows users please refer to this guide for tips on setup.

Ruby on Rails

http://railsinstaller.org/en

Postgres

Check out http://www.postgresql.org/download/

OSX

Install via Homebrew

brew install postgresql

#####Linux

Bulid from the source using yum, apt-get, etc.

Windows

Install via graphical installer

Install Gems

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

bundle install

Possible Errors

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

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.

Running the App Locally

bin/rake db:create db:migrate
bin/rake db:setup
rails s

Accessing the Database

rails db

Note that ifme_test is used when running unit tests

Testing Accounts

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: [email protected]
Password: password99
Email: [email protected]
Password: password99
Email: [email protected]
Password: password99

Unit Tests

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

Committing Work

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 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: http://www.if-me.org/contributors.

Find the source code for that page and submit a pull request with your story!

License

The source code is licensed under the Apache License. For more information see http://www.apache.org/licenses/ or LICENSE.txt.

ifme's People

Contributors

bellawoo avatar chenghw avatar danielglatstein avatar dawa12 avatar dburgoyne avatar dleve123 avatar emitche avatar fpcyan avatar gurpreetg avatar iuliiakot avatar jellene4eva avatar jolim24601 avatar julianguyen avatar juliepagano avatar jzshen avatar lucyyu24 avatar nguyenjenny avatar tienyuan avatar wdhorton avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.