{"id":19243866,"url":"https://github.com/grocy/grocy-desktop","last_synced_at":"2025-05-16T15:06:04.850Z","repository":{"id":49366469,"uuid":"141474050","full_name":"grocy/grocy-desktop","owner":"grocy","description":"A (Windows) desktop application wrapper for https://github.com/grocy/grocy","archived":false,"fork":false,"pushed_at":"2025-03-28T19:25:02.000Z","size":335865,"stargazers_count":304,"open_issues_count":0,"forks_count":26,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-03T13:17:34.037Z","etag":null,"topics":["cefsharp","csharp","erp","food","groceries","grocy","home","ownyourdata","self-hosted"],"latest_commit_sha":null,"homepage":"https://grocy.info","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grocy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://grocy.info/#say-thanks"]}},"created_at":"2018-07-18T18:24:21.000Z","updated_at":"2025-03-28T19:24:55.000Z","dependencies_parsed_at":"2024-04-13T15:31:43.181Z","dependency_job_id":"a9a285cb-ec86-445a-bdba-8f5140624fde","html_url":"https://github.com/grocy/grocy-desktop","commit_stats":null,"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grocy%2Fgrocy-desktop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grocy%2Fgrocy-desktop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grocy%2Fgrocy-desktop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grocy%2Fgrocy-desktop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grocy","download_url":"https://codeload.github.com/grocy/grocy-desktop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248565021,"owners_count":21125414,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cefsharp","csharp","erp","food","groceries","grocy","home","ownyourdata","self-hosted"],"created_at":"2024-11-09T17:20:34.927Z","updated_at":"2025-04-12T11:52:21.439Z","avatar_url":"https://github.com/grocy.png","language":"C#","funding_links":["https://grocy.info/#say-thanks"],"categories":[],"sub_categories":[],"readme":"-----\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg alt=\"Logo\" height=\"50\" src=\"https://raw.githubusercontent.com/grocy/grocy/master/public/img/logo.svg?sanitize=true\" /\u003e\n\u003ch2\u003eGrocy Desktop\u003c/h2\u003e\n\u003ch3\u003eA (Windows) desktop application wrapper for \u003ca href=\"https://github.com/grocy/grocy\"\u003eGrocy\u003c/a\u003e\u003c/h3\u003e\n\u003cem\u003e\u003ch4\u003eThis is a hobby project by \u003ca href=\"https://berrnd.de\"\u003eBernd Bestel\u003c/a\u003e\u003c/h4\u003e\u003c/em\u003e\n\u003c/div\u003e\n\n-----\n\n## Questions / Help / Bug Reports / Feature Requests\n\n- General help and usage questions \u0026rarr;  [r/grocy subreddit](https://www.reddit.com/r/grocy)\n- Bug Reports and Feature Requests \u0026rarr; [Issue Tracker](https://github.com/grocy/grocy-desktop/issues/new/choose)\n\n_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._\n\n## How to install\n\n- Classic installer\n  - Just download and execute the [latest release setup](https://releases.grocy.info/latest-desktop), afterwards you will have a \"Grocy\" shortcut on your desktop.\n- Microsoft Store  \n\u003ca href=\"https://apps.microsoft.com/detail/9NWB1TRNNKSF\"\u003e\u003cimg src=\"https://github.com/grocy/grocy-desktop/raw/master/.github/publication_assets/microsoft-store-badge-en.png\" alt=\"Get it from Microsoft\" width=\"150px\" /\u003e\u003c/a\u003e\n\nPlease note that user data is not automatically transfered when switching between the classic installer and the Microsoft Store version, please use the [backup/restore functionality](#how-to-backuprestore) to transfer your data.\n\n## How to update\n\nJust download and execute the [latest release installer](https://releases.grocy.info/latest-desktop). When using the Microsoft Store version, updates happen automatically as usual.\n\n## How to backup/restore\n\nAll user data can be exported and restored as a ZIP file (see the `Grocy` and `Barcode Buddy` (if enabled) menu in the top menu bar).\n\n## Localization\n\nGrocy Desktop is fully localizable - the default language is English (integrated into code), a German localization is always maintained by me.\n\nYou can easily help translating Grocy on [Transifex](https://explore.transifex.com/grocy/grocy-desktop/) if your language is incomplete or not available yet.\n\nAny translation which once reached a completion level of 70 % will be included in releases.\n\nGrocy Desktop and Grocy will automatically use the localization based on your system language, if available.\n\n## Barcode Buddy integration\n\n[Barcode Buddy](https://github.com/Forceu/barcodebuddy) is a community contributed barcode helper tool for Grocy and can be activated via `File -\u003e Enable Barcode Buddy`.\n\n## External access\n\nBoth, Grocy and Barcode Buddy (if enabled), can be optionally accessed from external machines, external access can be enabled via `File -\u003e Enable external access` (please accept the native Windows firewall question accordingly).\nSee the status bar for information about the URLs.\n\n_This should only be used in trusted (local) networks._\n\n## User data synchronization\n\nIf you want to have Grocy Desktop on more than one machine, you can enable synchronization of all user data via `File -\u003e Enable user data synchronization`.\nAll user data will be exported to the selected directory an closing the application and restored on application start (e. g. use any cloud-synced directory for that).\n\n## Motivation\n\nGrocy is a selfhosted PHP web application, so normally runs on webservers. If you are not so familiar with the technical things regarding webservers, but just want to have Grocy running like a normal (Windows) desktop application, this is what you need.\n\n## Things worth to know\n\n### How this works technically\n\nGrocy Desktop is a .Net Windows Forms application. It uses [CefSharp](https://github.com/cefsharp/CefSharp) as an integrated browser and utilizes [nginx](https://nginx.org) and [PHP](https://www.php.net/) (FastCGI)  to host Grocy. The UWP app (`.appx` package to be distributed through the Microsoft Store) is built using [Desktop Bridge](https://techcommunity.microsoft.com/blog/modernworkappconsult/desktop-bridge-8211-the-bridge-between-desktop-apps-and-the-universal-windows-pl/316488), all needed dependencies/manifests are located in the `appx_dependencies` folder.\n\n### What the installer does\n\nThe installer has bundled, beside the application itself and the CefSharp dependencies, a for Grocy configured PHP and nginx version (in `embedded_dependencies/php.zip` / `embedded_dependencies/nginx.zip`) and the current Grocy and Barcode Buddy release.\n\nEverything will be unpacked to `%programfiles%\\grocy-desktop` by default, the path can also be changed during the installation process. (This does not apply when running/installing the UWP app, normally from the Microsoft Store - UWP apps have their own default package locations.)\n\n### What happens on start\n\nGrocy Desktop will do the following things and then opens the locally hosted instance in the integrated browser:\n- Unpacking the dependency ZIP files, if needed, to `%appdata%\\grocy-desktop\\runtime-dependencies`\n  - Grocy to `%appdata%\\grocy-desktop\\grocy`\n  - Barcode Buddy (if enabled) to `%appdata%\\grocy-desktop\\barcodebuddy`\n  - When running the UWP app (normally installed from the Microsoft Store) the used paths are\n    - `%userprofile%\\.grocy-desktop\\runtime-dependencies`\n    - `%userprofile%\\.grocy-desktop\\grocy`\n    - `%userprofile%\\.grocy-desktop\\barcodebuddy`\n- Configuring Grocy and Barcode Buddy (if enabled) in embedded mode (user data will be saved to `%appdata%\\grocy-desktop\\grocy-data` / `%appdata%\\grocy-desktop\\barcodebuddy-data`, these paths can be changed (see the `Grocy` and `Barcode Buddy` (if enabled) menu in the top menu bar)\n  - When running the UWP app (normally installed from the Microsoft Store), the default path used is `%userprofile%\\.grocy-desktop\\grocy-data` / `%userprofile%\\.grocy-desktop\\barcodebuddy-data`\n  - The default ports used are `4010` for Grocy and `4011` for Barcode Buddy, if they're already used, a random free port is used instead\n- Starting nginx, bound to `localhost` if external access is disabled, otherwise bound to all network interfaces\n- Starting PHP FastCGI, bound to `localhost` on a random free port\n\n## Contributing / Say Thanks\n\nAny help is welcome, feel free to contribute anything which comes to your mind or see \u003chttps://grocy.info/#say-thanks\u003e if you just want to say thanks.\n\n## Roadmap\n\nThere is none. The progress of a specific bug/enhancement is always tracked in the corresponding issue, at least by commit comment references.\n\n## Screenshots\n\n![Grocy Desktop](https://github.com/berrnd/grocy-desktop/raw/master/.github/publication_assets/grocy-desktop.png \"Grocy Desktop\")\n\n## How to build\n\nYou will need Visual Studio 2022. All dependencies are included, available via NuGet or will be downloaded at compile time (see the build events).\nThe setup is built using [WiX Toolset](https://wixtoolset.org), which should be installed along with the [Wix Toolset Visual Studio 2022 Extension](https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2022Extension).\n\nTo build the `.appx` package (UWP app) you'll need the [Windows SDK 10.0.22621.0](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/) (this is done in the Post-build event of the `grocy-desktop-setup` project).\n\n## License\n\nThe MIT License (MIT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrocy%2Fgrocy-desktop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrocy%2Fgrocy-desktop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrocy%2Fgrocy-desktop/lists"}