moncycle_ynh/README.md

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# Moncycle for YunoHost

[![Integration level](https://dash.yunohost.org/integration/moncycle.svg)](https://dash.yunohost.org/appci/app/moncycle) ![Working status](https://ci-apps.yunohost.org/ci/badges/moncycle.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/moncycle.maintain.svg)
[![Install Moncycle with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=moncycle)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Moncycle quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

## Overview

Rendre facile le suivi des cycles menstruels et l’application des méthodes naturelles.
Billings . Symptothermie . FertilityCare

# L’APPLICATION

👩 un tableau de suivi du cycle menstruel
🌳 dédiée aux méthodes naturelles
🤏 suivi de l'évolution de la glaire cervicale
🌡️ suivi de la température corporelle (optionnel)
🔠 notation FertilityCare (optionnel)
📱 simple sur téléphone comme sur PC
✨ visuel esthétique avec mode sombre
📖 code open source
🤪 pas de pseudo intelligence prédictive
📊 export PDF/CSV pour vos moniteurs/instructrices
🔢 fini Excel ou Google Sheets
💑 un même compte sur plusieurs appareils
✉️ envoi par mail automatique des cycles
🔒 pas de vente de données / pas de publicité
🇫🇷 hébergée et développée en France

# LES MÉTHODES NATURELLES

Les méthodes naturelles ? «Ce sont des méthodes basées sur la connaissance des signes de fertilité du cycle féminin. Le couple peut ainsi connaitre avec précision les périodes fertiles ou infertiles qu'il traverse, et en fonction de son projet d'enfant, connaitre le meilleur moment pour transmettre la vie, ou les périodes infertiles lorsqu'il souhaite espacer ou limiter les naissances.» Source: methodes-naturelles.fr

Il existe plusieurs méthodes proposées par différentes associations. Voici une liste non exhaustive:

[Méthode Billings](https://www.methode-billings.com/)
👉 méthode compatible avec moncycle.app

[Symptothermie (Cyclamen)](http://www.methodes-naturelles.fr/les_methodes_naturelles/la-methode-dauto-observation)
👉 méthode compatible avec moncycle.app

[Symptothermie (SensiPlan)](https://symptothermie.info/)
👉 méthode compatible avec moncycle.app

[FertilityCare (NaProTechnologie)](https://www.fertilitycare.fr/)
👉 méthode compatible avec moncycle.app

🧠 moncycle.app n'a pas pour objectif de prédire ou de contrôler la bonne application des méthodes (ni de remplacer vos moniteurs) mais seulement de proposer un support numérique. Vous restez le cerveau derrière votre tableau. Si vous ne connaissez pas les méthodes naturelles ou si vous avez des questions sur les règles de celles-ci, rapprochez-vous d'un moniteur de l'une des associations ci-dessus.

**Shipped version:** 7.0~ynh1

**Demo:** https://tableau.moncycle.app/connexion.php?email1=demo@moncycle.app&mdp=demo

## Screenshots

![Screenshot of Moncycle](./doc/screenshots/moncycle_app.png)

## Disclaimers / important information

* No LDAP integration
* After installing, you can create your own user using the form
* Once done, you can (if you want) set the account creation to false in `/var/www/moncycle_app/config.php`
* If you want to use the app in PWA mode, be sure to be connected to your account first

## Documentation and resources

* Official app website: <https://moncycle.app>
* Official user documentation: <https://www.moncycle.app>
* Official admin documentation: <https://github.com/jean-io/moncycle.app>
* Upstream app code repository: <https://github.com/jean-io/moncycle.app>
* YunoHost documentation for this app: <https://yunohost.org/app_moncycle>
* Report a bug: <https://github.com/YunoHost-Apps/moncycle_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/moncycle_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/moncycle_ynh/tree/testing --debug
or
sudo yunohost app upgrade moncycle -u https://github.com/YunoHost-Apps/moncycle_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>