Ultimate Recipe App Template

Documentation version 3.1

Getting Started #back to top

This documentation will help you familiarise yourself with the 'Ultimate Recipe App Template' Android App and the web based Admin page. It is suggested that you first upload the admin page to your server and make sure it is working before continuing to the Android App. The Android App will work fine using the demo server, however it is required to setup firebase for it to work well without errors. The setup of Firebase is explained in the Admin Page Video Tutorial.

Setting up the admin Page #back to top

Before You Start

  • 1. Make sure your server supports PHP 5.5 or above and MySQL.
  • 2. In the video tutorial the free hosting offered by www.byet.host was used. Recently I noted that this is not working anymore with their free version. So feel free to use any other hosting you wish, or you might wish to pay for their premium hosting, which should work.

Uploading To Server

  • Step 1 - Upload the contents of the 'Server Side Code' to your server. Make sure you don't forget the .htaccess.

  • Step 2 - Create a new MySQL database and import 'RecipeApp_SQL_DB.sql'.

  • Step 4 - Put your database details (Host, database name, user name, and password) in config.ini. The fields are marked with red below.

  • Step 5 - Access the /index.php file that you just uploaded to your server, using your browser. The default login credentials are:
    										Username: admin
    										Password: pass

Setting Firebase Push Notifications

  • Step 1 - Go to your Firebase Console, go to settings->cloud messaging and get your server key (API_ACCESS_KEY). Put this in config.ini. The field is marked with green above.

  • Step 2 - Admin Page Done!

Setting up the Android App#back to top

Before You Start

  1. Make sure your have Android Studio 2.2 installed and in the Android SDK Manager make sure you have the following installd:

    • Build tools v24.0.3
    • Google play-services v9.6.1
    • Android SDK Tools 25.2.2
    • Android SDK Platform-Tools 24.0.3
    • Google USB Driver
    • Android API 24 SDK

  2. Try to place the project file as close to root (C:/) as possible as windows has a path character limit of 240chars. So, if you get the error:"Failed to crunch file...", reduce the path length.

Importing and running

  • Step 1 - Open up Android Studio and click 'open an existing Android Studio project'.

  • Step 2 - Drag and drop the 'Recipe App' folder in the dialog to go quickly to the folder.

  • Step 3 - Make sure 'Recipe App' is highlighted and click 'ok'.

  • Step 4 - Go to your Firebase Console and download the 'google-services.json' file and replace the placeholder in app/google-services.json. This step is included in the Admin Page video - If you skip this step you will encounter an error during compile time.

  • Step 5 - Press the Play button to test the app on the emulator or connect your phone via usb to your computer to try it on your phone.

Changing Package name

This step must be done else you will have problems uploading to Google play and the Rate feature will not work.

  • Step 1 - Make sure the 'Compact Empty Middle Packages' option is deselected as shown below.

  • Step 2 - Rename the package id by right clicking on 'neurondigital' and selecting 'refactor' and 'rename' as shown below.

  • Step 3 - In the popup menu type in your company name. Then press 'refactor' and in the next popup window press 'Do Refactor'. Do the same for 'recipeapp'. The package name should be in this format: com.yourcompany.AppName

  • Step 4 - Open app/build.gradle and put in the same package id as before instead of the 'com.neurondigital.recipeapp'. This is shown below.

App Customisation

  • Step 1 - Put in your Server url in Configurations.java

  • Step 2 - Replace the share deep link url in Configurations.java and in AndroidManifest.xml. When the user opens a url that matches the url you specified here, it would be opened up in the recipe app. If the app is not installed, the url would be opened on the browser, so make sure to choose a domain that contains a button to download the app.

Replace icon and Images

  1. The images can be found under app/res/drawable. To replace the images just copy/paste the image in the drawable folder to replace the other.

  2. The icons can be found in app/res/mipmap. Notice that there are different sizes. To replace the icons just right-click->new->Image Asset and select your image.

Add AdMob interstitial Ads (optional)

  • Create an interstitial Ad on AdMob and paste the AD unit Id in the strings.xml file. The Ad displays when the user clicks a recipe in home. Make sure to add this to start making money from your App. The display rate can be changed from strings.xml from the ad_shows_every_X_clicks parameter.

Add AdMob Banner Ads (optional)

  • Like the interstitial Ad, create a Banner Ad on AdMob and paste the AD unit Id in the strings.xml file. The Ad displays in the bottom of the screen. Ideally to not annoy the user, it's either the banner or the interstitial ad, so you may wish to leave one of the Ad IDs in strings.xml empty.

Google Analytics (optional)

  • Create a new google Analytics property and you'll be provided with a tracking id which should have this format: "UA-xxxxxxxx-xx". Put this tracking id in strings.xml in the 'google_analytics_id' field.

In-App Purchase

To use this feature you need to purchase an 'Extended License' of the template from CodeCanyon. This feature is not covered in the 'Regular License.'

  • Step 1 - The template allows for the user to purchase a premium upgrade to remove ads using google Play In-app Payments. Before doing so, create your app in Google Play Dashboard and locate the 'Public Key' as it can seen below:

  • Step 2 - Then add a new in-app product and give it a Product id.

  • Step 3 - Finally, put your Public Key and product id in configuration.java:


  • All translatable text is contained within the strings.xml file.

Export your App as a .APK for Google Play

  • Go to Build| Generate Signed APK... and export the .APK file.

Grid View or Card View

  • Go to Configurations.java. Replace the LIST_2COLUMNS in the second line displayed below, with LIST_FULLWIDTH if you wish to use card view.

Support Desk #back to top

If you need any support,

  1. First check the FAQ questions of the item on codecanyon.
  2. If you don't find anything there check the item comments section.
  3. If you still don't find your answer it would be best to ask your question in the comments section for others to see.
  4. For private support, please send me a message via my Codecanyon page.

Support for my items includes:
  • * Responding to questions or problems regarding the item and its features
  • * Fixing bugs and reported issues
  • * Providing updates to ensure compatibility with new software versions
Item support does not include:
  • * Customization and installation services
  • * Support for third party software and plug-ins
Before seeking support, please...
  • * Make sure your question is a valid Theme Issue and not a customization request.
  • * Make sure you have read through the documentation and any related video guides before asking support on how to accomplish a task.
  • * Make sure to double check the template FAQs.
  • * If you have customized the template and now have an issue, back-track to make sure you didn't make a mistake. If you have made changes and can't find the issue, please provide us with your changelog.

Version History (Changelog) #back to top

						Version 1 - Oct 8th, 2016

						- Initial Upload

						Version 2 - Nov 29th, 2016

						- Added a feature to enable user to submit a recipe from the App. The admin then can accept it or delete it from Admin Page.
						- Optional Grid View option for recipe list. Switchable from configurations.java.
						- Feature to Share Shopping Cart.
						- Grid View shows how much a recipe has been viewed and favorited
						- Added Cache to the app. This will enable the app to work offline, using the local data.
						- Fixed bug that prevented the app from loading more than a certain recipes.
						- Fixed the database collation to accept utf-8 characters.

						Version 3 - Feb 2nd, 2017

						- Bug Fix - Not uploading utf8 text in suggest recipe. Problems with arabic text.
						- Bug Fix - Recipe name is hidden when one column text is long. Fixed with staggered list.
						- Changed recipe order to Ascending order. Last Recipe uploaded will now display first.
						- Bug Fix - When a recipe was removed from favorites, all favorites were being removed.
						- Bug Fix - If no ad unit id was being added an error would be given.
						- Option to Send push notification to users when a recipe is saved.
						- The shopping cart is divided with Recipe Subheaders.
						- The shopping cart icon is replaced by a checked icon when an ingredient is added to shopping cart
						- Option to add Multiple images to each recipe. Now the user can scroll left/right on the image to see the next/previous image.

						Version 3.1 - March 14th, 2017

						- Bug Fix - The shopping cart deletes items in undo when closed
						- Utf-8 languages (arabic..) are now supported in app search.
						- Utf-8 languages (arabic..) are now supported in category names
						- Bug Fix - UI Issues with add recipe modal when adding an image/video.
						- Bug Fix - The app was not opening the right recipe when searching.
						- Bug Fix - Problem when refreshing catagories.
						- Bug Fix - The included .sql file had corrupted categories.