🍲 A library for all your recipes
Перейти к файлу
Sebastian Fey b83e4d0256 docs: Restructure README, move clients documentation to separate file.
Signed-off-by: Sebastian Fey <info@sebastianfey.de>
2023-12-14 19:58:35 +01:00
.github Bump to version 0.11.0 2023-12-14 10:22:40 +01:00
.helpers
.hook-checkout
.hooks
.img
.tx
.vscode
appinfo Bump to version 0.11.0 2023-12-14 10:22:40 +01:00
assets
docs docs: Restructure README, move clients documentation to separate file. 2023-12-14 19:58:35 +01:00
img
l10n
lib
src
templates
tests
translationfiles
.codecov.yml
.editorconfig
.eslintignore
.eslintrc.yml
.gitignore
.l10nignore
.php-cs-fixer.dist.php
.prettierignore
.prettierrc.json
CHANGELOG.md
COPYING
DEVELOPMENT.md
LICENSE
Makefile
README.md docs: Restructure README, move clients documentation to separate file. 2023-12-14 19:58:35 +01:00
composer.json
composer.lock
cookbook.code-workspace
package-lock.json
package.json Bump to version 0.11.0 2023-12-14 10:22:40 +01:00
phpunit.integration.xml
phpunit.migration.xml
phpunit.xml
psalm.xml
stylelint.config.js
webpack.config.js
webpack.devel.js

README.md

# 🧑‍🍳 Nextcloud Cookbook
Join us on Matrix

CI-tests codecov GitHub GitHub language count GitHub Repo stars GitHub all releases

A screenshot of how the app looks

A library for all your recipes. It uses JSON files following the schema.org recipe format. To add a recipe to the collection, you can paste in the URL of the recipe, and the provided web page will be parsed and downloaded to whichever folder you specify in the app settings.

Further documentation (also internal ones) are published on the documentation pages of the project.

📱 Clients

The app works generally in any modern browser. Additionally, there are some more specialized clients available, including mobile apps for Android and iOS. You can find an overview here.

💼 Is it Production Ready?

⚠️ IMPORTANT ⚠️
Users of this app are practically testers. We're limited on resources and still working out how to make this app function the best it can. There will be regressions and bugs. And we of course appreciate constructive feedback whenever users run into them.

💰 Sponsoring

We thank the sponsors of this project for their support as open-source software.

Blackfire Logo

Browserstack Logo

📖 F.A.Q.

I can't see my recipes

Recipes are only shown in the UI if they are present in the database. It is likely you have recipes that haven't been indexed/added to the database yet. Try clicking the Settings > Rescan library button to compare the database with what is in your recipes folder and apply any differences to the database.

If this still doesn't work, a full, non-incremental resync might help. This can be done by setting your recipes folder to a different (ideally empty) folder to clear the database. Setting the recipes folder back to what it was before should cause all your recipes to sync again, effectively refreshing the database.

"Could not load recipe" when trying to download recipes?

A lot of websites are unfortunately not following the schema.org/Recipe standard, which makes their recipes impossible to read by this app.

A website using correct schema.org markup is not being read correctly The parser is far from perfect. If you can help out in any way, please [have a look at the parseRecipeHtml() method](https://github.com/nextcloud/nextcloud-cookbook/blob/master/lib/Service/RecipeService.php) and create a pull request with your changes.
All of the text is in English? This app uses the [Transifex](https://app.transifex.com/nextcloud/nextcloud/cookbook/) translation system. You might want to register there to help translating the app to new languages or report errors in existing translations.