mirror of
https://github.com/grocy/grocy.git
synced 2026-03-27 23:29:25 +01:00
Updated .github files
This commit is contained in:
parent
487631397c
commit
29033a28a9
14
.github/CONTRIBUTING.md
vendored
Normal file
14
.github/CONTRIBUTING.md
vendored
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
## Help & Usage Questions
|
||||||
|
→ [r/grocy on Reddit](https://www.reddit.com/r/grocy)
|
||||||
|
|
||||||
|
## Bug Reports & Feature Requests
|
||||||
|
→ [Issue Tracker](https://github.com/grocy/grocy/issues/new/choose)
|
||||||
|
|
||||||
|
## Say thanks
|
||||||
|
→ <https://grocy.info/#say-thanks>
|
||||||
|
|
||||||
|
## Translations
|
||||||
|
→ [Transifex](https://explore.transifex.com/grocy/grocy/)
|
||||||
|
|
||||||
|
## Pull Requests
|
||||||
|
This project does not accept code contributions.
|
||||||
7
.github/ISSUE_TEMPLATE/bug-report.md
vendored
7
.github/ISSUE_TEMPLATE/bug-report.md
vendored
|
|
@ -1,7 +1,6 @@
|
||||||
---
|
---
|
||||||
name: Bug Report
|
name: Bug Report
|
||||||
about: If you've found something that does not work, please report it to help improve
|
about: If you've found something that does not work, please report it to help improve Grocy
|
||||||
Grocy
|
|
||||||
title: 'Bug: '
|
title: 'Bug: '
|
||||||
labels: bug
|
labels: bug
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
@ -13,8 +12,8 @@ Please make sure to:
|
||||||
|
|
||||||
- Describe the bug as detailed as possible by providing the exact steps how to reproduce it
|
- Describe the bug as detailed as possible by providing the exact steps how to reproduce it
|
||||||
- Attach screenshots where useful
|
- Attach screenshots where useful
|
||||||
- Check if the problem was maybe already reported or fixed by searching open and closed issues here
|
- Check if the problem was maybe already reported or fixed by searching open and also already closed requests here
|
||||||
- Keep it to one topic per issue
|
- Keep it to one topic per request
|
||||||
|
|
||||||
Please also try to reproduce the problem on the pre-release demo: => https://demo-prerelease.grocy.info
|
Please also try to reproduce the problem on the pre-release demo: => https://demo-prerelease.grocy.info
|
||||||
- Use a private demo instance to make your example persistent
|
- Use a private demo instance to make your example persistent
|
||||||
|
|
|
||||||
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
|
|
@ -1,5 +1,5 @@
|
||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: Questions / Help
|
- name: Help & Usage Questions
|
||||||
url: https://www.reddit.com/r/grocy
|
url: https://www.reddit.com/r/grocy
|
||||||
about: Please use the r/grocy subreddit for general help and usage questions
|
about: Please use the r/grocy subreddit for general help and usage questions
|
||||||
|
|
|
||||||
5
.github/ISSUE_TEMPLATE/feature-request.md
vendored
5
.github/ISSUE_TEMPLATE/feature-request.md
vendored
|
|
@ -1,7 +1,6 @@
|
||||||
---
|
---
|
||||||
name: Feature Request
|
name: Feature Request
|
||||||
about: Ideas for improvements or new things which you would find useful are always
|
about: Ideas for improvements or new things which you would find useful are always welcome
|
||||||
welcome
|
|
||||||
title: 'Feature Request: '
|
title: 'Feature Request: '
|
||||||
labels: enhancement
|
labels: enhancement
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
@ -12,6 +11,6 @@ assignees: ''
|
||||||
Please make sure to:
|
Please make sure to:
|
||||||
|
|
||||||
- Describe what you would find useful as detailed as possible
|
- Describe what you would find useful as detailed as possible
|
||||||
- Check if your idea was maybe already requested by searching open requests here
|
- Check if your idea was maybe already requested by searching open and also already closed requests here
|
||||||
- Keep it to one topic per request
|
- Keep it to one topic per request
|
||||||
-->
|
-->
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2017 Bernd Bestel
|
Copyright (c) 2017-2026 Bernd Bestel <https://berrnd.de>
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
23
README.md
23
README.md
|
|
@ -20,7 +20,7 @@ See the website. → <https://grocy.info>
|
||||||
|
|
||||||
## Questions / Help / Bug Reports / Feature Requests
|
## Questions / Help / Bug Reports / Feature Requests
|
||||||
|
|
||||||
- General help and usage questions → [r/grocy subreddit](https://www.reddit.com/r/grocy)
|
- General help and usage questions → [r/grocy on Reddit](https://www.reddit.com/r/grocy)
|
||||||
- Bug Reports and Feature Requests → [Issue Tracker](https://github.com/grocy/grocy/issues/new/choose)
|
- Bug Reports and Feature Requests → [Issue Tracker](https://github.com/grocy/grocy/issues/new/choose)
|
||||||
|
|
||||||
_Please don't send me private messages or call me regarding anything Grocy. I check the issue tracker and the subreddit pretty much daily, but don't provide any support beyond that._
|
_Please don't send me private messages or call me regarding anything Grocy. I check the issue tracker and the subreddit pretty much daily, but don't provide any support beyond that._
|
||||||
|
|
@ -33,7 +33,7 @@ See the website for a list of community contributed Add-ons / Tools. → [htt
|
||||||
|
|
||||||
> Checkout [Grocy Desktop](https://github.com/grocy/grocy-desktop), if you want to run Grocy without having to manage a webserver just like a normal (Windows) desktop application.
|
> Checkout [Grocy Desktop](https://github.com/grocy/grocy-desktop), if you want to run Grocy without having to manage a webserver just like a normal (Windows) desktop application.
|
||||||
>
|
>
|
||||||
> Directly download the [latest release](https://releases.grocy.info/latest-desktop) - the installation is nothing more than just clicking 2 times "next".
|
> Directly download the [latest release](https://releases.grocy.info/latest-desktop) (also [available via the Microsoft Store](https://apps.microsoft.com/detail/9NWB1TRNNKSF)) - the installation is nothing more than just clicking 2 times "next".
|
||||||
|
|
||||||
Grocy is technically a pretty simple PHP application, so the basic notes to get it running are:
|
Grocy is technically a pretty simple PHP application, so the basic notes to get it running are:
|
||||||
- Unpack the [latest release](https://releases.grocy.info/latest)
|
- Unpack the [latest release](https://releases.grocy.info/latest)
|
||||||
|
|
@ -52,7 +52,6 @@ See the website for more installation guides and troubleshooting help. → [h
|
||||||
|
|
||||||
- PHP 8.2 or 8.3 (with SQLite 3.34.0+)
|
- PHP 8.2 or 8.3 (with SQLite 3.34.0+)
|
||||||
- Required PHP extensions: `fileinfo`, `pdo_sqlite`, `gd`, `ctype`, `intl`, `zlib`, `mbstring`
|
- Required PHP extensions: `fileinfo`, `pdo_sqlite`, `gd`, `ctype`, `intl`, `zlib`, `mbstring`
|
||||||
- _Recommendation: Benchmark tests showed that e.g. unit conversion handling is up to 5 times faster when using a more recent (3.39.4+) SQLite version._
|
|
||||||
- Recent Firefox, Chrome or Edge
|
- Recent Firefox, Chrome or Edge
|
||||||
|
|
||||||
## How to run using Docker
|
## How to run using Docker
|
||||||
|
|
@ -64,7 +63,7 @@ See the website for more installation guides and troubleshooting help. → [h
|
||||||
- Overwrite everything with the [latest release](https://releases.grocy.info/latest) while keeping the `data` directory
|
- Overwrite everything with the [latest release](https://releases.grocy.info/latest) while keeping the `data` directory
|
||||||
- Check `config-dist.php` for new configuration options and add them to your `data/config.php` where appropriate (the default values from `config-dist.php` will be used for not in `data/config.php` defined settings)
|
- Check `config-dist.php` for new configuration options and add them to your `data/config.php` where appropriate (the default values from `config-dist.php` will be used for not in `data/config.php` defined settings)
|
||||||
|
|
||||||
If you run Grocy on Linux, there is also `update.sh` (remember to make the script executable (`chmod +x update.sh`) and ensure that you have `unzip` installed) which does exactly this and additionally creates a backup (`.tgz` archive) of the current installation in `data/backups` (backups older than 60 days will be deleted during the update).
|
If you run Grocy on Linux, there is also `update.sh` (remember to make the script executable via `chmod +x update.sh` and ensure that you have `unzip` installed) which does exactly this and additionally creates a backup (`.tgz` archive) of the current installation in `data/backups` (backups older than 60 days will be deleted during the update).
|
||||||
|
|
||||||
## Localization
|
## Localization
|
||||||
|
|
||||||
|
|
@ -78,7 +77,7 @@ The [pre-release demo](https://demo-prerelease.grocy.info) is available for any
|
||||||
|
|
||||||
Also any translation which once reached a completion level of 70 % ([`strings` resource](https://app.transifex.com/grocy/grocy/strings/)) will be included in releases.
|
Also any translation which once reached a completion level of 70 % ([`strings` resource](https://app.transifex.com/grocy/grocy/strings/)) will be included in releases.
|
||||||
|
|
||||||
_RTL languages are unfortunately not yet supported._
|
_RTL languages are not yet supported._
|
||||||
|
|
||||||
## Motivation
|
## Motivation
|
||||||
|
|
||||||
|
|
@ -94,9 +93,9 @@ The web frontend uses exactly this API for pretty much everything. So everything
|
||||||
|
|
||||||
### Barcode readers & camera scanning
|
### Barcode readers & camera scanning
|
||||||
|
|
||||||
Some fields (with a barcode icon above) also allow to select a value by scanning a barcode. It works best when your barcode reader prefixes every barcode with a letter which is normally not part of a item name (I use a `$`) and sends a `TAB` after a scan.
|
Some fields (with a barcode icon) also allow to select a value by scanning a barcode. It works best when your barcode reader prefixes every barcode with a letter which is normally not part of a item name (I use a `$`) and sends a `TAB` after a scan.
|
||||||
|
|
||||||
Additionally it's also possible to use your device camera to scan a barcode by using the camera button on the right side of the corresponding input field (powered by [ZXing](https://github.com/zxing-js/library), totally offline / client-side camera stream processing, please note due to browser security restrictions, this only works when serving Grocy via a secure connection (`https://`)). [Here](https://www.youtube.com/watch?v=veezFX4X1JU) and [there](https://www.youtube.com/watch?v=Y5YH6IJFnfc) are quick video demos of that.
|
Additionally it's also possible to use your device camera to scan a barcode by using the camera button on the right side of the corresponding input field (powered by [ZXing](https://github.com/zxing-js/library), totally offline / client-side camera stream processing. Please note due to browser security restrictions, this only works when serving Grocy via a secure connection (`https://`)). [Here](https://www.youtube.com/watch?v=veezFX4X1JU) and [there](https://www.youtube.com/watch?v=Y5YH6IJFnfc) are quick video demos of that.
|
||||||
|
|
||||||
_My personal recommendation: Use a USB barcode laser scanner. They are cheap and work 1000% better, faster, under any lighting condition and from any angle._
|
_My personal recommendation: Use a USB barcode laser scanner. They are cheap and work 1000% better, faster, under any lighting condition and from any angle._
|
||||||
|
|
||||||
|
|
@ -115,11 +114,11 @@ See that plugin or `plugins/DemoBarcodeLookupPlugin.php` for a commented example
|
||||||
For (productivity) reasons all date (and time) input (and display) fields use the ISO-8601 format regardless of localization.
|
For (productivity) reasons all date (and time) input (and display) fields use the ISO-8601 format regardless of localization.
|
||||||
The following shorthands are available:
|
The following shorthands are available:
|
||||||
- `MMDD` gets expanded to the given day on the current year, if > today, or to the given day next year, if < today, in proper notation
|
- `MMDD` gets expanded to the given day on the current year, if > today, or to the given day next year, if < today, in proper notation
|
||||||
- Example: `0517` will be converted to `2025-05-17`
|
- Example: `0517` will be converted to `2026-05-17`
|
||||||
- `YYYYMMDD` gets expanded to the proper ISO-8601 notation
|
- `YYYYMMDD` gets expanded to the proper ISO-8601 notation
|
||||||
- Example: `20250417` will be converted to `2025-04-17`
|
- Example: `20260417` will be converted to `2026-04-17`
|
||||||
- `YYYYMMe` or `YYYYMM+` gets expanded to the end of the given month in the given year in proper notation
|
- `YYYYMMe` or `YYYYMM+` gets expanded to the end of the given month in the given year in proper notation
|
||||||
- Example: `202507e` will be converted to `2025-07-31`
|
- Example: `202607e` will be converted to `2026-07-31`
|
||||||
- `[+/-]n[d/m/y]` gets expanded to a date relative to today, while adding (**+**) or subtracting (**-**) the **n**umber of **d**ays/**m**onths/**y**ears, in proper notation
|
- `[+/-]n[d/m/y]` gets expanded to a date relative to today, while adding (**+**) or subtracting (**-**) the **n**umber of **d**ays/**m**onths/**y**ears, in proper notation
|
||||||
- Example: `+1m` will be converted to the same day next month
|
- Example: `+1m` will be converted to the same day next month
|
||||||
- `x` gets expanded to `2999-12-31` (which is an alias for "never overdue")
|
- `x` gets expanded to `2999-12-31` (which is an alias for "never overdue")
|
||||||
|
|
@ -167,11 +166,11 @@ In embedded mode, settings can be overridden by text files in `data/settingoverr
|
||||||
|
|
||||||
## Contributing / Say Thanks
|
## Contributing / Say Thanks
|
||||||
|
|
||||||
Any help is welcome, feel free to contribute anything which comes to your mind or see <https://grocy.info/#say-thanks> if you just want to say thanks.
|
See <https://grocy.info/#say-thanks> if you just want to say thanks or [Contributing](https://github.com/grocy/grocy?tab=contributing-ov-file#contributing-ov-file) for anything else.
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|
||||||
There is none. The progress of a specific bug/enhancement is always tracked in the corresponding issue, at least by commit comment references.
|
There is none. The progress of a specific bug/enhancement is always tracked in the corresponding request, at least by commit comment references.
|
||||||
|
|
||||||
[Milestones](https://github.com/grocy/grocy/milestones) are used to indicate in which version the corresponding request was done (`vNEXT` means it's currently planned to do that for the next release).
|
[Milestones](https://github.com/grocy/grocy/milestones) are used to indicate in which version the corresponding request was done (`vNEXT` means it's currently planned to do that for the next release).
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user