ERP beyond your fridge
Public demo of the latest version → https://demo.grocy.info
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 is a pain to use 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 houshold management"-thing.
For now my main focus is on stock management, ERP your fridge!
Just unpack the latest release on your PHP (currently only tested with PHP 7.2) enabled webserver (webservers root should point to the /public
directory), copy config-dist.php
to data/config.php
, edit it to your needs, ensure that the data
directory is writable and you're ready to go.
Default login is user admin
with password admin
- see the data/config.php
file. Alternatively clone this repository and install Composer and Bower dependencies manually.
If you use nginx as your webserver, please include try_files $uri /index.php;
in your location block.
If, however, your webserver does not support URL rewriting, set DISABLE_URL_REWRITING
in data/config.php
.
Just overwrite everything with the latest release while keeping the /data
directory, check config-dist.php
for new configuration options and add them to your data/config.php
(it will show up as an error if something is missing there).
See the integrated Swagger UI instance on /api.
Some fields 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.
For (productivity) reasons all date (and time) input fields use the ISO-8601 format regardless of localization. The following shorthands are available:
MMDD
gets expanded to the given day on the current year in proper notation- Example:
0517
will be converted to2018-05-17
- Example:
YYYYMMDD
gets expanded to the proper ISO-8601 notation- Example:
20190417
will be converted to2019-04-17
- Example:
x
gets expanded to2999-12-31
(which I use for products which never expire)- Down/up arrow keys will increase/decrease the date by one day
- Right/left arrow keys will increase/decrease the date by 1 week
Wherever a button contains a bold highlighted letter, this is a shortcut key.
Example: Button "Add as new product" can be "pressed" by using the P
key on your keyboard.
Products can be directly added to the database via looking them up against external services by a barcode.
This is currently only possible through the REST API.
There is no plugin included for any service, see the reference implementation in data/plugins/DemoBarcodeLookupPlugin.php
.
Database schema migration is automatically done when visiting the root (/
) route (click on the logo in the left upper edge).
When the file data/demo.txt
exists, the application will work in a demo mode which means authentication is disabled and some demo data will be generated during the database schema migration.
When the file data/add_before_end_body.html
exists, the contents of the file be added just before </body>
on every page, useful for your own JS/CSS without to have to modify the application itself.
The MIT License (MIT)