RecipeManager
Api and Frontend to Manage your recipes. Written with Laravel and Vue.js.
A tool to manage your families and friends recipes like a chef.
Why is this so awesome?
- Manage your recipes You and your friends can save, edit and delete recipes.
- Share recipes You can share recipes by one click via Telegram or E-Mail.
- Calculate yield amounts Calculate yield amounts directly in the recipe on the fly.
- Exactly define recipe properties ..like author, category, tags, ingredients, units and more.
- Disable/Enable functionalities Disable or enable dynamically cookbooks and/or tags.
- Great and easy API Access the easy-to-use REST-API.
What features are planned?
- Unit and feature tests
- Improve and add advanced searching and filtering
- An advanced User-Role-System
- Import & more export types of recipes
- Nutrition informations
- Rating system (the API code is already written ;-) )
- Social login with Socialite
- A feature you think is missing...
Getting Started
Get the latest release or clone the repo with
git clone https://github.com/ammannbe/RecipeManager.git
Prerequisites
- LAMP Stack or Docker for production use
- Requirements for laravel
- GD and WebP for image manipulation
- Composer
- NPM
- MeiliSearch
- Redis (optional but not recommended)
Installation
It's recommended to install and update this software with docker/docker-compose. See here for more information.
Alternatively or for development purposes you can make a manual installation on any linux/unix machine:
Manual installation
- Install composer packages
composer install - Install NPM packages
npm install - Copy .env.example to .env and modify it to your needs
- Generate storage symlink
php artisan storage:link - Generate an app key
php artisan key:generate - Migrate the database
php artisan migrate - Import meilisearch indexes
php artisan scout:index recipes && php artisan scout:import "App\Models\Recipes\Recipe" - Add following to your crontab:
* * * * * www-data cd /path-to-the-project && php artisan schedule:run >> /dev/null 2>&1
- Run the server
php artisan serve
Manual development deployment
- If not already done, install everything
- Run the server
php artisan serve - Run the queue worker
php artisan queue:work - Watch for style and js changes:
npm run watch
Manual production deployment
- If not already done, install everything
- Optimize composer autoload
composer install --optimize-autoloader --no-dev - Enable caching:
php artisan config:cache
php artisan route:cache
php artisan view:cache
- Run the queue worker
php artisan queue:work(or setup via e.g. systemd) - Optimize npm packages:
npm run prod
Update
- Get the latest source (see Getting Started)
- Check
.env.examplesfor changes - Optimize composer autoload
composer install - Install NPM packages
npm install - Migrate the database
php artisan migrate - Import meilisearch indexes
php artisan scout:index recipes && php artisan scout:import "App\Models\Recipes\Recipe" - Follow Development deployment or Production deployment
Translations
All application related files are translated with laravel-translation-manager and laravel-translations-loader.
You should run these commands only on a development machine.
You need to run the migrations for this package:
php artisan vendor:publish --provider="Barryvdh\TranslationManager\ManagerServiceProvider" --tag=migrations
php artisan migrate
- Import translations
composer run translations:import - Open
<your-domain>/translationsin a browser - PHP: short keys within
resources/lang/<lang>/<group>.php - Vue.js: translation strings within
/resources/lang/<lang>.json(these files will be imported into the_jsongroup) - Export & generate translations
composer run translations:export
Other commands:
- Export translations
php artisan translations:export \* - Reset translations
php artisan translations:reset
IDE helpers
You get better IDE IntelliSense support with the laravel-ide-helper package.
You need to generate the helpers by yourself:
composer run ide-helper:generate
After that, you should run the commands from Testing / Code Quality.
Testing / Code Quality
- Optional: seed the database with test data
# Seed the database with test data
php artisan db:seed
# Freshly migrate and seed the database
php artisan migrate:fresh --seed
# The secret of the seeded users is 'password'
- Run static code analytics
composer run phpstan - Run PHP Coding Standards Fixer
composer run php-cs-fixer
Built With
PHP Production:
- Askedio/laravel-soft-cascade - Cascade Delete & Restore when using Laravel SoftDeletes
- barryvdh/laravel-dompdf - A DOMPDF Wrapper for Laravel
- GrKamil/laravel-telegram-logging - Send logs to Telegram chat via Telegram bot
- laravel/laravel - A PHP framework for web artisans
- meilisearch/meilisearch-laravel-scout - Laravel Scout Engine for Meilisearch
- rutorika/sortable - Adds sortable behavior to Laravel Eloquent models
- spatie/laravel-medialibrary - Associate files with Eloquent models
PHP Development:
- barryvdh/laravel-ide-helper - Laravel IDE Helper
- barryvdh/laravel-translation-manager - Manage Laravel translation files
- nunomaduro/larastan - Adds static analysis to Laravel improving developer productivity and code quality
- stechstudio/Laravel-PHP-CS-Fixer - Artisan Command for FriendsOfPHP/PHP-CS_Fixer
JS:
- sass/sass - Sass makes CSS fun!
- vuejs/vue - Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
- axios/axios - Promise based HTTP client for the browser and node.js
- SortableJS/Vue.Draggable - Vue drag-and-drop component based on Sortable.js
- PeachScript/vue-infinite-loading - An infinite scroll plugin for Vue.js.
- timtnleeProject/vuejs-clipper - Vue.js image clipping components using Vue-Rx.
- vuejs/vue-rx - RxJS integration for Vue.js.
- kirschbaum-development/laravel-translations-loader - Webpack loader to import Laravel translation files (PHP or JSON) into your JS bundle as JSON.
- sparksuite/simplemde-markdown-editor - A simple, beautiful, and embeddable JavaScript Markdown editor.
- jonschlinkert/remarkable - Markdown parser, done right.
Contributing
Please see CONTRIBUTING for details.
Authors
- Benjamin Ammann - Initial work - ammannbe
License
This project is licensed under the AGPLv3 or later - see the LICENSE file for details
4 Aug 22, 2022
223 Jan 5, 2023
1 Oct 25, 2021
6.2k Jan 5, 2023
23 Dec 15, 2022
1 Dec 3, 2021
349 Jan 8, 2023
3.7k Jan 7, 2023
30 Dec 3, 2022
1k Dec 29, 2022
435 Jan 5, 2023
5 Nov 23, 2022
11 May 10, 2022
8 Aug 9, 2022
34 Sep 17, 2022
10 Dec 14, 2022
6 Dec 28, 2021
6 Oct 2, 2022