2021-07-16 20:00:39 +02:00
|
|
|
<!--
|
|
|
|
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.
|
|
|
|
-->
|
|
|
|
|
2020-12-16 19:56:57 +01:00
|
|
|
# Grocy for YunoHost
|
|
|
|
|
2022-06-11 10:12:38 +02:00
|
|
|
[![Integration level](https://dash.yunohost.org/integration/grocy.svg)](https://dash.yunohost.org/appci/app/grocy) ![Working status](https://ci-apps.yunohost.org/ci/badges/grocy.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/grocy.maintain.svg)
|
2020-12-26 19:51:35 +01:00
|
|
|
[![Install Grocy with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grocy)
|
2020-12-16 19:56:57 +01:00
|
|
|
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
2021-07-16 20:00:39 +02:00
|
|
|
> *This package allows you to install Grocy 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.*
|
2020-12-16 19:56:57 +01:00
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
2021-12-09 11:50:09 +01:00
|
|
|
grocy is a web-based self-hosted groceries & household management solution for your home.
|
2020-12-16 19:56:57 +01:00
|
|
|
|
2023-01-12 09:28:16 +01:00
|
|
|
**Shipped version:** 3.3.2~ynh2
|
2020-12-16 19:56:57 +01:00
|
|
|
|
2021-07-16 20:00:39 +02:00
|
|
|
**Demo:** https://en.demo.grocy.info/stockoverview
|
|
|
|
|
|
|
|
## Screenshots
|
2020-12-16 19:56:57 +01:00
|
|
|
|
2022-06-11 10:12:38 +02:00
|
|
|
![Screenshot of Grocy](./doc/screenshots/stock-en.png)
|
2020-12-16 19:56:57 +01:00
|
|
|
|
2021-07-16 20:00:39 +02:00
|
|
|
## Disclaimers / important information
|
2020-12-16 19:56:57 +01:00
|
|
|
|
2020-12-16 22:41:01 +01:00
|
|
|
## Configuration
|
|
|
|
|
|
|
|
Default login
|
2021-07-16 20:00:39 +02:00
|
|
|
```
|
2022-02-08 14:07:34 +01:00
|
|
|
user: admin
|
|
|
|
password: admin
|
2021-07-16 20:00:39 +02:00
|
|
|
```
|
2020-12-16 19:56:57 +01:00
|
|
|
|
|
|
|
## Limitations
|
|
|
|
|
2021-01-22 10:30:09 +01:00
|
|
|
:warning: For now, Grocy must be installed in a root domain or subdirectory.
|
2020-12-16 19:56:57 +01:00
|
|
|
|
2021-07-16 20:00:39 +02:00
|
|
|
## Documentation and resources
|
2020-12-16 19:56:57 +01:00
|
|
|
|
2022-06-11 10:12:38 +02:00
|
|
|
* Official app website: <https://grocy.info/>
|
|
|
|
* Upstream app code repository: <https://github.com/grocy/grocy>
|
|
|
|
* YunoHost documentation for this app: <https://yunohost.org/app_grocy>
|
|
|
|
* Report a bug: <https://github.com/YunoHost-Apps/grocy_ynh/issues>
|
2020-12-16 19:56:57 +01:00
|
|
|
|
|
|
|
## Developer info
|
|
|
|
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/grocy_ynh/tree/testing).
|
|
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
2022-06-11 10:12:38 +02:00
|
|
|
|
|
|
|
``` bash
|
2020-12-16 19:56:57 +01:00
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/grocy_ynh/tree/testing --debug
|
|
|
|
or
|
|
|
|
sudo yunohost app upgrade grocy -u https://github.com/YunoHost-Apps/grocy_ynh/tree/testing --debug
|
|
|
|
```
|
2021-07-16 20:00:39 +02:00
|
|
|
|
2022-06-11 10:12:38 +02:00
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|