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
2 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-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
Testing (#33) * Upgrade to v.3.0.0 * Fix * Fix * Add README_fr * Fix * Update nginx.conf * Fix * Update manifest.json * Update upgrade * Update upgrade * Remove service * Update upgrade * Update config-dist.php * Remove path * Update README_fr.md * Update README_fr.md * Upgrade to 3.0.1 (#4) * Upgrade to 3.0.1 * 3.0.1 (#7) * Upgrade to 3.0.1 * Update manifest.json * add pull request * Cleaning up * Update manifest.json * Cleaning up * Fix * Fix path * Fix * Fix permissions * [autopatch] Update issue and PR templates (#11) * Testing (#9) * Cleaning up * [autopatch] Update issue and PR templates Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: Yunohost-Bot <> * Fix * [autopatch] Update issue and PR templates (#12) * Testing (#9) * Cleaning up * [autopatch] Update issue and PR templates Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: Yunohost-Bot <> * Add headers (#13) * Cleaning up * Update manifest.json * 3.1.0 (#15) * 3.1.0 * Fix * Auto-update README * Fix * Auto-update README * Set client_max_body_size to 50M * Update manifest.json * Auto-update README * Update manifest.json * 3.1.1 * Auto-update README * Fix * Update manifest.json * Upgrade 3.1.2 (#20) * Auto-update README * Add mbstring * Update manifest.json * Auto-update README * 3.1.3 (#24) * 3.1.3 * Allow api (#27) * Allow API * Update upgrade * Update scripts/upgrade Co-authored-by: tituspijean <tituspijean@outlook.com> Co-authored-by: tituspijean <tituspijean@outlook.com> * Update manifest.json * Auto-update README * remove https * Update DESCRIPTION.md * Auto-update README * Add config panel * Ericgaspar patch 1 (#30) * Testing (#28) * Allow API * Create updater.yml * Auto-update README * Update upgrade * Fix * Auto-update README * version bump * Auto-update README * 3.2.0 * Auto-update README * Update manifest.json * Update manifest.json * Upgrade to v3.2.0 (#36) Co-authored-by: yunohost-bot <yunohost-bot@users.noreply.github.com> Co-authored-by: YunoHost Bot <yunohost-bot@users.noreply.github.com> Co-authored-by: Yunohost-Bot <> Co-authored-by: tituspijean <tituspijean@outlook.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2022-04-03 22:52:11 +02:00
**Shipped version:** 3.2.0~ynh1
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
```
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
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