ifmeorg/ifme

View on GitHub
README.md

Summary

Maintainability
Test Coverage
[![CircleCI](https://circleci.com/gh/ifmeorg/ifme/tree/main.svg?style=svg)](https://circleci.com/gh/ifmeorg/ifme/tree/main)
[![Code Climate](https://codeclimate.com/github/ifmeorg/ifme/badges/gpa.svg)](https://codeclimate.com/github/ifmeorg/ifme)
[![Test Coverage](https://api.codeclimate.com/v1/badges/f9444a4d4116720518fe/test_coverage)](https://codeclimate.com/github/ifmeorg/ifme/test_coverage)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg)](code_of_conduct.md)
[![Backers on Open Collective](https://opencollective.com/ifme/backers/badge.svg)](#backers)
[![Sponsors on Open Collective](https://opencollective.com/ifme/sponsors/badge.svg)](#sponsors)
[![Awesome Humane Tech](https://raw.githubusercontent.com/humanetech-community/awesome-humane-tech/main/humane-tech-badge.svg?sanitize=true)](https://github.com/humanetech-community/awesome-humane-tech)

README in: [Italian](https://github.com/ifmeorg/ifme/blob/main/README-IT.md), [Spanish](https://github.com/ifmeorg/ifme/blob/main/README-ES.md), [Portuguese](https://github.com/ifmeorg/ifme/blob/main/README-PT.md), [French](https://github.com/ifmeorg/ifme/blob/main/README-FR.md), [Korean](https://github.com/ifmeorg/ifme/blob/main/README-KO.md), [Indonesian](https://github.com/ifmeorg/ifme/blob/main/README-ID.md), [Turkish](https://github.com/ifmeorg/ifme/blob/main/README-TR.md), [Sinhala](https://github.com/ifmeorg/ifme/blob/main/README-LK.md), [Chinese](https://github.com/ifmeorg/ifme/blob/main/README-CN.md),
[Hindi](https://github.com/ifmeorg/ifme/blob/main/README-HI.md), [Arabic](https://github.com/ifmeorg/ifme/blob/main/README-AR.md), [Vietnamese](https://github.com/ifmeorg/ifme/blob/main/README-VI.md)

# if-me.org

[if-me.org](https://www.if-me.org/) 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.

The live site can be found at [if-me.org](https://www.if-me.org/). The live design systems can be found at [design.if-me.org](http://design.if-me.org/).

We use the wonderful [Contributor Covenant](http://contributor-covenant.org) for
our code of conduct. Please
[read it](https://github.com/ifmeorg/ifme/blob/main/code_of_conduct.md)
before joining our project.

**Read about our project goals and how to contribute (not just as a developer) [here](https://github.com/ifmeorg/ifme/blob/main/CONTRIBUTING.md).**

## Documentation

Please check out our [Wiki](https://github.com/ifmeorg/ifme/wiki) for full documentation.

### Installation

[These are the instructions](https://github.com/ifmeorg/ifme/wiki/Installation) for setting up and installing the app. Test, development, and production instances are covered.

### Contributor Blurb

Everyone is highly encouraged to [add themselves](https://github.com/ifmeorg/ifme/wiki/Contributor-Blurb) to our Contribute page.

## Donate

We also welcome financial contributions in full transparency on our
[Open Collective](https://opencollective.com/ifme).
Anyone can file an expense. If the expense makes sense for the development of
the community, it will be "merged" in the ledger of our Open Collective by the
core contributors and the person who filed the expense will be reimbursed.

### Backers

Thank you to our Patreon backers [Rob Drimmie](https://www.patreon.com/user?u=3251857),
[Joseph D. Marhee](https://www.patreon.com/user?u=2899171), and
[Carol Willing](https://www.patreon.com/user?u=202458)!

Thank you to all our Open Collective backers!
[Become a backer!](https://opencollective.com/ifme#backer)

<a href="https://opencollective.com/ifme#backers" target="_blank"><img src="https://opencollective.com/ifme/backers.svg?width=890"></a>

### Sponsors

Thank you to all our sponsors! (please ask your company to also support this
open source project by [becoming a sponsor](https://opencollective.com/ifme#sponsor))

<section role="presentation">
  <a href="https://opencollective.com/ifme/sponsor/0/website" target="_blank"><img src="https://opencollective.com/ifme/sponsor/0/avatar.svg"></a>
  <a href="https://opencollective.com/ifme/sponsor/1/website" target="_blank"><img src="https://opencollective.com/ifme/sponsor/1/avatar.svg"></a>
  <a href="https://opencollective.com/ifme/sponsor/2/website" target="_blank"><img src="https://opencollective.com/ifme/sponsor/2/avatar.svg"></a>
  <a href="https://opencollective.com/ifme/sponsor/3/website" target="_blank"><img src="https://opencollective.com/ifme/sponsor/3/avatar.svg"></a>
  <a href="https://opencollective.com/ifme/sponsor/4/website" target="_blank"><img src="https://opencollective.com/ifme/sponsor/4/avatar.svg"></a>
  <a href="https://opencollective.com/ifme/sponsor/5/website" target="_blank"><img src="https://opencollective.com/ifme/sponsor/5/avatar.svg"></a>
  <a href="https://opencollective.com/ifme/sponsor/6/website" target="_blank"><img src="https://opencollective.com/ifme/sponsor/6/avatar.svg"></a>
  <a href="https://opencollective.com/ifme/sponsor/7/website" target="_blank"><img src="https://opencollective.com/ifme/sponsor/7/avatar.svg"></a>
  <a href="https://opencollective.com/ifme/sponsor/8/website" target="_blank"><img src="https://opencollective.com/ifme/sponsor/8/avatar.svg"></a>
  <a href="https://opencollective.com/ifme/sponsor/9/website" target="_blank"><img src="https://opencollective.com/ifme/sponsor/9/avatar.svg"></a>
</section>

## 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](https://github.com/ifmeorg/ifme/blob/main/LICENSE.txt).