framaforms_ynh/README.md

# Framaforms for YunoHost

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

> *This package allows you to install Framaforms 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
Framaforms is an online forms and surveys service. Registered users are allowed to create forms, share them, collect and visualize results through a simple interface.
See https://framablog.org/2016/10/05/framaforms-noffrez-plus-les-reponses-que-vous-collectez-a-google/ (in French ) and https://framablog.org/2016/10/05/en-savoir-un-peu-plus-sur-le-projet-framaforms/ (in French) for further informations.

**Shipped version:** 1.0.1

## Screenshot

![Animation that present how to build a form with Framaforms](https://framaforms.org/profiles/framaforms_org/files/imgforms/anim_creation.gif)

## Demo

* [Official demo](https://framaforms.org/)

## Configuration

You can modify some configurations using the Framaforms administration panel. You can log in with the admin user and the password you gave during installation.

## Documentation

 * Official documentation: https://docs.framasoft.org/fr/framaforms/
 * YunoHost documentation: https://yunohost.org/#/app_framaforms

## YunoHost specific features

#### Multi-user support

* Are LDAP and HTTP auth supported? **No**
* Can the app be used by multiple users? **Yes**

#### Supported architectures

* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/framaforms%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/framaforms/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/framaforms%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/framaforms/)

## Limitations

* Any known limitations.

## Additional information

* Other info you would like to add about this app.

## Links

 * Report a bug: https://github.com/YunoHost-Apps/framaforms_ynh/issues
 * App website: https://framaforms.org/
 * Upstream app repository: https://framagit.org/framasoft/framaforms
 * YunoHost website: https://yunohost.org/

---

## Developer info

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

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/framaforms_ynh/tree/testing --debug
or
sudo yunohost app upgrade framaforms -u https://github.com/YunoHost-Apps/framaforms_ynh/tree/testing --debug
```
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00			`# Framaforms for YunoHost`

Apply last example_ynh 2020-06-03 01:58:54 +02:00			`[![Integration level](https://dash.yunohost.org/integration/framaforms.svg)](https://dash.yunohost.org/appci/app/framaforms) ![](https://ci-apps.yunohost.org/ci/badges/framaforms.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/framaforms.maintain.svg)`
			`[![Install Framaforms with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=framaforms)`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00
Apply last example_ynh 2020-06-03 01:58:54 +02:00			`> *This package allows you to install Framaforms 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.*`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00
			`## Overview`
typos 2020-10-01 22:57:11 +02:00			`Framaforms is an online forms and surveys service. Registered users are allowed to create forms, share them, collect and visualize results through a simple interface.`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00			`See https://framablog.org/2016/10/05/framaforms-noffrez-plus-les-reponses-que-vous-collectez-a-google/ (in French ) and https://framablog.org/2016/10/05/en-savoir-un-peu-plus-sur-le-projet-framaforms/ (in French) for further informations.`

typos 2020-10-01 22:57:11 +02:00			`Shipped version: 1.0.1`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00
typos 2020-10-01 22:57:11 +02:00			`## Screenshot`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00
typos 2020-10-01 22:57:11 +02:00			`![Animation that present how to build a form with Framaforms](https://framaforms.org/profiles/framaforms_org/files/imgforms/anim_creation.gif)`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00
			`## Demo`

			`* [Official demo](https://framaforms.org/)`

			`## Configuration`

typos 2020-10-01 22:57:11 +02:00			`You can modify some configurations using the Framaforms administration panel. You can log in with the admin user and the password you gave during installation.`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00
			`## Documentation`

			`* Official documentation: https://docs.framasoft.org/fr/framaforms/`
typos 2020-10-01 22:57:11 +02:00			`* YunoHost documentation: https://yunohost.org/#/app_framaforms`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00
			`## YunoHost specific features`

Apply last example_ynh 2020-06-03 01:58:54 +02:00			`#### Multi-user support`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00
typos 2020-10-01 22:57:11 +02:00			`* Are LDAP and HTTP auth supported? No`
			`* Can the app be used by multiple users? Yes`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00
			`#### Supported architectures`

Apply last example_ynh 2020-06-03 01:58:54 +02:00			`* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/framaforms%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/framaforms/)`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00			`* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/framaforms%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/framaforms/)`

			`## Limitations`

			`* Any known limitations.`

			`## Additional information`

Apply last example_ynh 2020-06-03 01:58:54 +02:00			`* Other info you would like to add about this app.`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00
			`## Links`

			`* Report a bug: https://github.com/YunoHost-Apps/framaforms_ynh/issues`
			`* App website: https://framaforms.org/`
			`* Upstream app repository: https://framagit.org/framasoft/framaforms`
			`* YunoHost website: https://yunohost.org/`

			`---`

Update README.md 2020-10-01 22:21:56 +02:00			`## Developer info`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00
Apply last example_ynh 2020-06-03 01:58:54 +02:00			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/framaforms_ynh/tree/testing).`
[wip] Apply new example_ynh template 2019-06-14 18:57:58 +02:00
			`To try the testing branch, please proceed like that.`
			```
			`sudo yunohost app install https://github.com/YunoHost-Apps/framaforms_ynh/tree/testing --debug`
			`or`
			`sudo yunohost app upgrade framaforms -u https://github.com/YunoHost-Apps/framaforms_ynh/tree/testing --debug`
			```