Skip to content

Latest commit

 

History

History
124 lines (102 loc) · 5.69 KB

README_v5.md

File metadata and controls

124 lines (102 loc) · 5.69 KB
Raw

PHPReceipbook 6.0

Code has been committed for V6. Will be testing against Heroku and other servers to find any issues. Feel free to pull and play with it. A formal release will be out after testing completes.

This version uses CakePHP 3.9 to support PHP 7.x+.

PHPRecipebook 5.0

PHPRecipeBook is a cookbook and meal planning software.

Demo site (Create your own account)

Demo Videos:

Features:

  • AJAX Page loads (so less refreshes/data between clicks)
  • Clean navigation
  • Meal Planner
  • Setup wizard is included and a complete migration script.
  • Integration PrestoFresh online grocery, ability to extend to other vendors.
  • Enhanced Password security encryption
  • More databases supported because of CakePHP abstraction.
  • Built using CakePHP

Now that we are on GitHub contributions and collaboration should be must easier.
Look forward to anyone with some skills to jump in and keep this moving.

Installation

There are two ways to install PHPRecipebook. The first option is to use Git to get the code. This option will allow for very easy upgrades but a little more upfront effort. The second option is to simply download the tar.gz file and extract. This option is very easy upfront but upgrades will require more effort copying files around.

Git Install Option

  • Clone 'PHPRecipebook' repository.
  • Get PHP Composer installed. https://getcomposer.org/download/. Composer is used to manage dependencies and make upgrading CakePHP easier.
  • Run 'php composer.phar install' in the application directory to get CakePHP and check dependencies.
  • To upgrade later simply run 'git pull'. Resolve merge conflicts if needed.

Download Install Option

Setup Directions for all

  • Ensure you have the following PHP Modules installed: mcrypt, gd. And mysql, pgsql or your DB.
  • Create a new database to store the application in. i.e. recipebook
  • Edit Configuration DB Configuration Settings /Config/database.php to match your database settings.
  • Edit <app dir/Config/core.php and set your language if other than English. Go to translations below if not available.
  • Make the /temp folder in the application writable for web user. example:
    • sudo chown -R apache.apache tmp If you don't make /tmp writable by the web user the app will not run!
  • For File uploads:
    • mkdir /webroot/files/recipe
    • sudo chown . /webroot/files/recipe
  • Launch the website and complete steps in wizard.

Upgrades in 5.x Series

Between releases you can update your database by running

  • Get latest release (git or Release download).
  • ./Console/cake schema update
  • removing all files from ./tmp/cache/models

Heroku Deployment

  • Clone PHPRecipebook to your computer.
  • Create an account on heroku and step through their tutorial if you have never done so before.
  • In the PHPRecipebook local repo run: heroku create
  • Run: heroku addons:add heroku-postgresql:hobby-dev
  • edit Config/database.php and put in commented out heroku config, remove block for normal db config.
  • edit .gitignore and remove 'Config/database.php' line to allow
  • commit changes (git)
  • git push heroku master
  • heroku open
  • heroku run bash
    • (then follow setup directions for): ./Console/cake schema create
  • modify core.php and change setup to false. Commit.
    • git push heroku master
  • reload web page and then login with your password that you set during the setup of the app.

Troubleshooting

  • App does not load:
  • You get this error: Warning: include(//Vendor/cakephp/cakephp/lib/Cake/Error/ErrorHandler.php): failed to open stream:
    • Solution: Clear the ./tmp/cache/models, ./tmp/cache/persistent directories. These folders keep path info in them so if the path the app runs from changes the cache has to be cleared.
  • Page loads but is missing images.
    • Solution: Check your apache configuration to ensure it allows overrides and mod_rewrite is installed. The .htaccess files are not properly working and rewriting the URL. You know this is working when the images load on the login page.

Translations

If your local language is not yet translated I can run it up against Google Translate API. Please star the project (show you care) and submit an 'Issue' to translate.

If you are interested in performing a translation/corrections then here are some basic steps to follow:

  • Install Poedit (http://poedit.net/). This is an Open Source tool that will help in translations. Hint for Ubuntu installs - sudo apt-get install poedit
  • Open the /Locale/default.pot in Poedit and translate
  • When done save in Locale<lang code>\LC_MESSAGES\default.po

Currently Supported Languages / Translation Code

  • Chinese - zho
  • Danish - dan
  • Dutch - nld
  • English - eng
  • Estonian - est
  • French - fra
  • German - deu
  • Hungarian - hun
  • Italian - ita
  • Japanese - jpn
  • Korean - kor
  • Norwegian - nor
  • Portuguese - por
  • Turkish - tur
  • Serbian - srp
  • Spanish - spa
  • Swedish - swe