2021-07-16 20:00:39 +02:00
|
|
|
<!--
|
2024-04-06 17:27:56 +02:00
|
|
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
2021-07-16 20:00:39 +02:00
|
|
|
It shall NOT be edited by hand.
|
|
|
|
-->
|
|
|
|
|
2020-12-16 19:56:57 +01:00
|
|
|
# Grocy for YunoHost
|
|
|
|
|
2023-03-23 15:26:20 +01: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
|
|
|
|
2024-04-06 17:27:56 +02:00
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
2020-12-16 19:56:57 +01:00
|
|
|
|
2024-04-06 17:27:56 +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.
|
2024-04-06 17:27:56 +02:00
|
|
|
|
2024-03-19 23:01:55 +01:00
|
|
|
**Shipped version:** 4.2.0~ynh1
|
2020-12-16 19:56:57 +01:00
|
|
|
|
2024-03-19 23:01:55 +01:00
|
|
|
**Demo:** <https://en.demo.grocy.info/stockoverview>
|
2021-07-16 20:00:39 +02:00
|
|
|
|
|
|
|
## 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
|
|
|
## Documentation and resources
|
2020-12-16 19:56:57 +01:00
|
|
|
|
2024-03-19 23:01:55 +01:00
|
|
|
- Official app website: <https://grocy.info/>
|
|
|
|
- Upstream app code repository: <https://github.com/grocy/grocy>
|
|
|
|
- YunoHost Store: <https://apps.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
|
|
|
|
|
2024-04-06 17:27:56 +02:00
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/grocy_ynh/tree/testing).
|
2020-12-16 19:56:57 +01:00
|
|
|
|
2024-04-06 17:27:56 +02:00
|
|
|
To try the `testing` branch, please proceed like that:
|
2022-06-11 10:12:38 +02:00
|
|
|
|
2024-03-19 23:01:55 +01: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>
|