diff --git a/README.md b/README.md index eb4a9817e..989b9ced7 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ It is focused on simplicity for the whole family to enjoy. - Import recipes from around the web - Digitize paper recipes - Organize your recipes into cookbooks -- Works seamlessly with [Nextcloud Cookbook](https://apps.nextcloud.com/apps/cookbook) +- Easily migrate your recipes from [Mealie](https://mealie.io), [Tandoor](https://tandoor.dev) and [Nextcloud Cookbook](https://apps.nextcloud.com/apps/cookbook) - Automatic conversion to your preferred measurement system (imperial/metric) - Calculate nutritional information automatically - Print any recipe in your collection @@ -49,7 +49,23 @@ Follow these steps to build the project yourself: Alternatively, you may use the [development container](https://recipes.musicavis.ca/guide/docs/development/devcontainer/). Recipya's Docker [container](https://github.com/reaper47/recipya/tree/main/.devcontainer) includes all the necessary tools and dependencies -you need to start writing code quickly. +you need to start writing code quickly. + +### Updating + +#### Docker + +Please follow these [instructions](https://recipes.musicavis.ca/guide/docs/installation/docker/#updating-your-container-1) +to update your Docker instance. + +#### Release build + +If you installed a release build of Recipya, i.e. v1.0.0, then the software will notify you once an update is available. +You can [self-update](https://recipes.musicavis.ca/guide/docs/features/updater) the application from the settings dialog. + +Let's explain the mechanism developers. Basically, a cron job is run [every three days]((https://github.com/reaper47/recipya/blob/main/internal/jobs/jobs.go#L70-L82)) +to check whether there is a new GitHub release. If so, the update indicators in the UI will be enabled. Once the user presses +the "Update" button, the latest release is fetched, unpacked and the application restarted. ## Contributing diff --git a/docs/website/content/_index.md b/docs/website/content/_index.md index 01c7eeb66..82c88fbe6 100644 --- a/docs/website/content/_index.md +++ b/docs/website/content/_index.md @@ -24,59 +24,64 @@ layout: hextra-home {{< hextra/feature-grid >}} {{< hextra/feature-card -title="Curate Recipes" -subtitle="Effortlessly import your favorite recipes from around the web, digitize paper recipes, and add recipes manually." -class="aspect-auto md:aspect-[1.1/1] max-md:min-h-[340px]" -image="/images/curate.webp" -imageClass="small w-[180%] left-[36px] sm:w-[110%] dark:opacity-80" -style="background: radial-gradient(ellipse at 50% 80%,rgba(194,97,254,0.15),hsla(0,0%,100%,0));" ->}} + title="Curate Recipes" + subtitle="Effortlessly import your favorite recipes from around the web, digitize paper recipes, and add recipes manually." + class="aspect-auto md:aspect-[1.1/1] max-md:min-h-[340px]" + image="/images/curate.webp" + imageClass="small w-[180%] left-[36px] sm:w-[110%] dark:opacity-80" + style="background: radial-gradient(ellipse at 50% 80%,rgba(194,97,254,0.15),hsla(0,0%,100%,0));" + >}} {{< hextra/feature-card -title="One Measurement System" -subtitle="All your recipes can be converted to your preferred measurement system. Say goodbye to imperial or metric." -class="aspect-auto md:aspect-[1.1/1] max-lg:min-h-[340px]" -image="/images/view-recipe.webp" -imageClass="small w-[110%] sm:w-[110%] dark:opacity-80" -icon="globe" -style="background: radial-gradient(ellipse at 50% 80%,rgba(142,53,74,0.15),hsla(0,0%,100%,0));" ->}} + title="One Measurement System" + subtitle="All your recipes can be converted to your preferred measurement system. Say goodbye to imperial or metric." + class="aspect-auto md:aspect-[1.1/1] max-lg:min-h-[340px]" + image="/images/view-recipe.webp" + imageClass="small w-[110%] sm:w-[110%] dark:opacity-80" + icon="globe" + style="background: radial-gradient(ellipse at 50% 80%,rgba(142,53,74,0.15),hsla(0,0%,100%,0));" + >}} {{< hextra/feature-card -title="Self-Hostable" -subtitle="Easily self-host the software on your server with Docker." -icon="desktop-computer" -class="aspect-auto md:aspect-[1.1/1] max-md:min-h-[340px]" -image="/images/devices.svg" -imageClass="small w-[110%] sm:w-[110%] dark:opacity-80" -style="background: radial-gradient(ellipse at 50% 80%,rgba(221,210,59,0.15),hsla(0,0%,100%,0));" ->}} + title="Self-Hostable" + subtitle="Easily self-host the software on your server with Docker." + icon="desktop-computer" + class="aspect-auto md:aspect-[1.1/1] max-md:min-h-[340px]" + image="/images/devices.svg" + imageClass="small w-[110%] sm:w-[110%] dark:opacity-80" + style="background: radial-gradient(ellipse at 50% 80%,rgba(221,210,59,0.15),hsla(0,0%,100%,0));" + >}} {{< hextra/feature-card -title="Nutrition Facts" -icon="information-circle" -subtitle="Let the software calculate nutritional information automatically when adding recipes." ->}} + title="Nutrition Facts" + icon="information-circle" + subtitle="Let the software calculate nutritional information automatically when adding recipes." + >}} {{< hextra/feature-card -title="Integrations" -icon="chip" -subtitle="Import recipes from different solutions. Thus far, you can import recipes from Nextcloud Cookbook and MasterCook." ->}} + title="Integrations" + icon="chip" + subtitle="Import your recipes from different solutions, such as Mealie, Tandoor, Nextcloud Cookbook, MasterCook, and Paprika." + >}} {{< hextra/feature-card -title="Wakelock" -icon="light-bulb" -subtitle="Prevent your device from going to sleep while viewing a recipe." ->}} + title="Wakelock" + icon="light-bulb" + subtitle="Prevent your device from going to sleep while viewing a recipe." + >}} {{< hextra/feature-card -title="Print" -icon="printer" -subtitle="Print any recipe or cookbook in your collection." ->}} + title="Print" + icon="printer" + subtitle="Print any recipe or cookbook in your collection." + >}} {{< hextra/feature-card -title="Responsive" -icon="device-mobile" -subtitle="Looks great on different screen sizes. Follows your system's theme." ->}} + title="Responsive" + icon="device-mobile" + subtitle="Looks great on different screen sizes. Follows your system's theme." + >}} {{< hextra/feature-card -title="And Much More..." -icon="sparkles" -subtitle="Please make sure not to overlook the features tour in the documentation for more!" ->}} + title="Cross-compiled" + icon="chip" + subtitle="Can be installed on Windows, Linux, and macOS." + >}} +{{< hextra/feature-card + title="And Much More..." + icon="sparkles" + subtitle="Please make sure not to overlook the features tour in the documentation for more!" + >}} {{< /hextra/feature-grid >}} diff --git a/docs/website/content/docs/_index.md b/docs/website/content/docs/_index.md index 8f842bdf2..5b79223e0 100644 --- a/docs/website/content/docs/_index.md +++ b/docs/website/content/docs/_index.md @@ -14,7 +14,7 @@ share your favorite recipes. It is focussed on simplicity for the whole family t - [Import recipes from around the web](/guide/docs/features/recipes/add#website) - [Digitize paper recipes](/guide/docs/features/recipes/add#scan) - [Organize your recipes into cookbooks](/guide/docs/features/cookbooks) -- [Works seamlessly with Nextcloud Cookbook](/guide/docs/features/integrations) +- [Easily migrate your recipes from Mealie, Tandoor and Nextcloud Cookbook](/guide/docs/features/integrations) - [Automatic conversion to your preferred measurement system](/guide/docs/features/measurement-systems) (imperial/metric) - [Calculate nutritional information automatically](/guide/docs/features/nutrition-facts) - [Print any recipe in your collection](/guide/docs/features/recipes/print) diff --git a/docs/website/themes/hextra b/docs/website/themes/hextra index e3b582676..6ee6ddeac 160000 --- a/docs/website/themes/hextra +++ b/docs/website/themes/hextra @@ -1 +1 @@ -Subproject commit e3b582676e5db64078053db99e3636e5b6311874 +Subproject commit 6ee6ddeacb9cdf80a390a762f202e0b4c8d0cd94 diff --git a/internal/server/handlers_settings_test.go b/internal/server/handlers_settings_test.go index 295679185..b65abdc2b 100644 --- a/internal/server/handlers_settings_test.go +++ b/internal/server/handlers_settings_test.go @@ -117,7 +117,7 @@ func TestHandlers_Settings(t *testing.T) { assertStatus(t, rr.Code, http.StatusOK) assertStringsInHTML(t, getBodyHTML(rr), []string{ - `

Recipya Version

v1.2.0 (update available)

Last checked: 0001-01-01
Last updated: 0001-01-01

Read the release notes

`, + `

Recipya Version

v1.2.0 (update available)

Last checked: 0001-01-01
Last updated: 0001-01-01

Read the release notes

`, }) })