1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/grocy_ynh.git synced 2024-09-03 19:25:54 +02:00
grocy_ynh/README.md

60 lines
1.9 KiB
Markdown
Raw Normal View History

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
[![Integration level](https://dash.yunohost.org/integration/grocy.svg)](https://dash.yunohost.org/appci/app/grocy) ![](https://ci-apps.yunohost.org/ci/badges/grocy.status.svg) ![](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-07-16 20:00:39 +02:00
Web-based groceries & household management solution for your home
2020-12-16 19:56:57 +01:00
2021-11-19 23:02:10 +01:00
**Shipped version:** 3.1.3~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
2021-07-16 20:00:39 +02:00
![](./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
```
user: **admin**
password: **admin**
```
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
2021-07-16 20:00:39 +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.
```
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
**More info regarding app packaging:** https://yunohost.org/packaging_apps