kenmirrors/grocy
1
0
Fork 0
mirror of https://github.com/grocy/grocy.git synced 2025-04-29 09:39:57 +00:00
Code Issues Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Bernd Bestel 2024-04-13 17:43:57 +02:00
parent 2f7478bddb
commit a68c1087dd
No known key found for this signature in database
GPG Key ID: 71BD34C0D4891300
3 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/ISSUE_TEMPLATE/bug-report.md vendored
View File

@ -18,5 +18,5 @@ Please make sure to:
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
- If the problem is not reproducible there, it's most likely not a bug - please use the r/grocy subreddit for general questions / help: => https://www.reddit.com/r/grocy - If the problem is not reproducible there, it's most likely not a bug - please use the r/grocy subreddit for general help and usage questions: => https://www.reddit.com/r/grocy
--> -->

2
.github/ISSUE_TEMPLATE/feature-request.md vendored
View File

@ -11,7 +11,7 @@ assignees: ''
<!-- <!--
Please make sure to: Please make sure to:
- Describe what you would find useful - 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 requests here
- Keep it to one topic per request - Keep it to one topic per request
--> -->

14
README.md
View File

@ -16,7 +16,7 @@
## Features ## Features
See the website &rarr; <https://grocy.info> See the website. &rarr; <https://grocy.info>
## Questions / Help / Bug Reports / Feature Requests ## Questions / Help / Bug Reports / Feature Requests
@ -84,7 +84,7 @@ _RTL languages are unfortunately not yet supported._
## Motivation ## Motivation
A household needs to be managed. I did this so far (almost 10 years) with my first self written software (a C# Windows forms application) and with a bunch of Excel sheets. The software was a pain to use at the end and Excel is Excel. So I searched for and tried different things for a (very) long time, nothing 100 % fitted, so this is my aim for a "complete household management"-thing. ERP your fridge! A household needs to be managed. Before Grocy I did this (for almost 10 years) using my first self written software (a C# Windows forms application) and with a bunch of Excel sheets. The software was a pain to use at the end and Excel is Excel. So I searched for and tried different things for a (very) long time, nothing 100 % fitted, so this is my aim for a "complete household management"-thing. ERP your fridge!
## Things worth to know ## Things worth to know
@ -92,6 +92,8 @@ A household needs to be managed. I did this so far (almost 10 years) with my fir
See the integrated Swagger UI instance on [/api](https://demo.grocy.info/api). See the integrated Swagger UI instance on [/api](https://demo.grocy.info/api).
The web frontend uses exactly this API for pretty much everything. So everything you can do there is also possible via the API.
### 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 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.
@ -105,11 +107,11 @@ _My personal recommendation: Use a USB barcode laser scanner. They are cheap and
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 `2023-05-17` - Example: `0517` will be converted to `2024-05-17`
- `YYYYMMDD` gets expanded to the proper ISO-8601 notation - `YYYYMMDD` gets expanded to the proper ISO-8601 notation
- Example: `20230417` will be converted to `2023-04-17` - Example: `20240417` will be converted to `2024-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: `202307e` will be converted to `2023-07-31` - Example: `202407e` will be converted to `2024-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")
@ -135,7 +137,7 @@ There is no plugin included for any service, see the reference implementation in
Database schema migration is automatically done when visiting the root (`/`) route (click on the logo in the left upper edge). Database schema migration is automatically done when visiting the root (`/`) route (click on the logo in the left upper edge).
_Please note: Database migrations are supposed to work between releases, not between every commit. If you want to run the current `master` branch (which is the development version), you need to handle that (and maybe more) yourself._ _Please note: Database migrations are supposed to work between releases, not between every commit. If you want to run the current `master` branch (which is the development version), you need to handle that (and more) yourself._
### Disable certain features ### Disable certain features