mirror of
https://github.com/YunoHost-Apps/cultivons_ynh.git
synced 2024-09-03 18:16:27 +02:00
137 lines
5.7 KiB
Markdown
137 lines
5.7 KiB
Markdown
<!--
|
||
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.
|
||
-->
|
||
|
||
# Cultivons pour YunoHost
|
||
|
||
[![Niveau d'intégration](https://dash.yunohost.org/integration/cultivons.svg)](https://dash.yunohost.org/appci/app/cultivons) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/cultivons.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/cultivons.maintain.svg)
|
||
[![Installer Cultivons avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cultivons)
|
||
|
||
*[Read this readme in english.](./README.md)*
|
||
|
||
> *Ce package vous permet d'installer Cultivons rapidement et simplement sur un serveur YunoHost.
|
||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||
|
||
## Vue d'ensemble
|
||
|
||
<!--
|
||
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.
|
||
-->
|
||
|
||
# Cultivons for YunoHost
|
||
|
||
[![Integration level](https://dash.yunohost.org/integration/cultivons.svg)](https://dash.yunohost.org/appci/app/cultivons) ![Working status](https://ci-apps.yunohost.org/ci/badges/cultivons.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/cultivons.maintain.svg)
|
||
[![Install cultivons with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cultivons)
|
||
|
||
*[Lire ce readme en français.](./README_fr.md)*
|
||
|
||
> *This package allows you to install cultivons 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
|
||
|
||
__Cultivons!__ is a software in the form of an internal site aiming at helping the management of a BAD (Sustainable Autonomous Base).
|
||
|
||
An BAD is a place where one or more people can (over)live a disaster (natural, plague, war, economic collapse ... put here the reason that pleases you or scares you the most), for a more or less long period of time, without needing the outside: supermarkets, hospitals, and other services present in a modern society.
|
||
|
||
This definition is a little broad, in fact a BAD will often materialize by a place in the countryside where one will try to be as autonomous as possible on the most important aspects of survival:
|
||
|
||
* food (vegetable garden, orchard, animals ... everything that is culture and breeding) ;
|
||
* electricity ;
|
||
* water (including potabilization) ;
|
||
* heating ;
|
||
* first aid ;
|
||
* storage of recipes, guides and other documentation ;
|
||
* ...
|
||
|
||
With __cultivons!__, you can manage
|
||
- your crops, your garden and the associated tasks (semi, harvest) as well as garden plan.
|
||
- the weather,
|
||
- the stocks,
|
||
- your documents,
|
||
- your budget (Bank Account).
|
||
|
||
### Features
|
||
- x
|
||
- x
|
||
|
||
**Shipped version:** 1.6
|
||
|
||
**Demo:** https://cultivons-demo.xulops.net
|
||
|
||
## Screenshots
|
||
|
||
![Screenshot of cultivons](./doc/screenshots/cultivonsfull.png)
|
||
|
||
## Documentation and resources
|
||
|
||
* Official app website: <https://xulops.net/forge/cultivons.php>
|
||
* Official admin documentation: <https://xulops.net/forge/cultivons.php>
|
||
* Upstream app code repository: <https://xulops.net/forge/cultivons.php?menu=download>
|
||
* YunoHost documentation for this app: <https://yunohost.org/app_cultivons>
|
||
* Report a bug: <https://github.com/YunoHost-Apps/cultivons_ynh/issues>
|
||
|
||
## Articles
|
||
|
||
* linuxfr <https://linuxfr.org/users/xulops/journaux/cultivons-logiciel-de-gestion-de-bad>
|
||
|
||
## Developer info
|
||
|
||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/cultivons_ynh/tree/testing).
|
||
|
||
To try the testing branch, please proceed like that.
|
||
|
||
``` bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/cultivons_ynh/tree/testing --debug
|
||
or
|
||
sudo yunohost app upgrade cultivons -u https://github.com/YunoHost-Apps/cultivons_ynh/tree/testing --debug
|
||
```
|
||
|
||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||
|
||
|
||
**Version incluse :** 1.0~ynh1
|
||
|
||
**Démo :** https://cultivons-demo.xulops.net
|
||
|
||
## Captures d'écran
|
||
|
||
![Capture d'écran de Cultivons](./doc/screenshots/cultivonsfull.png)
|
||
![Capture d'écran de Cultivons](./doc/screenshots/example.jpg)
|
||
|
||
## Avertissements / informations importantes
|
||
|
||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||
* requiring a full dedicated domain ?
|
||
* architectures not supported ?
|
||
* not-working single-sign on or LDAP integration ?
|
||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||
* etc...
|
||
|
||
* Other infos that people should be aware of, such as:
|
||
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||
* how to configure / administrate the application if it ain't obvious
|
||
* upgrade process / specificities / things to be aware of ?
|
||
* security considerations ?
|
||
|
||
## Documentations et ressources
|
||
|
||
* Site officiel de l'app : <https://xulops.net/forge/cultivons.php>
|
||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_cultivons>
|
||
* Signaler un bug : <https://github.com/YunoHost-Apps/cultivons_ynh/issues>
|
||
|
||
## Informations pour les développeurs
|
||
|
||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/cultivons_ynh/tree/testing).
|
||
|
||
Pour essayer la branche testing, procédez comme suit.
|
||
|
||
``` bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/cultivons_ynh/tree/testing --debug
|
||
ou
|
||
sudo yunohost app upgrade cultivons -u https://github.com/YunoHost-Apps/cultivons_ynh/tree/testing --debug
|
||
```
|
||
|
||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|