Documentation

Introduction

Please carefully read this guide in order to fully configure this template, and rememeber to test it on a Real Device - the Emulator may fail sometimes.

Quick Start

DO NOT RUN THE APP as soon as you'll unzip it from your downloaded package, because you must first create a free account on back4app.com, then a Parse App in the main Dashboard.
After that, replace the following strings with your own Parse App's App ID and Client Key in Configurations.java:
    public static String PARSE_APP_ID =     "pwkmVrsiHTp2wN3q3UXUBiOwiE5C31atCq2CihPy"
    public static String PARSE_CLIENT_KEY = "ugVWfJTY4azulDWoXmHVnkHkidlDzw6koSzrEVha"

Your app is now connected to your own database!
You can run the app one time only via Android Studio so you'll get an alert in the Home screen. That's because there's a line of code in the Home.java file which calls a function that creates the Categories and Products classes, along with some demo rows in your database.
Therefore, after getting that alert in your app at startup, stop the app and enter Home.java. Remove (or comment) this line of code into the onCreate() function:
    createDemoCategoryAndProduct();

Then you can enter your own Parse Dashboard - the database - refresh it and check the brand new Categories and Products classes with their demo rows.

General

Android Studio
This template has native Android Java/XML code so you can edit it only with Android Studio. If you don't have it, download it for free
Download Android Studio


Change App Name
Enter the string.xml file - it's into the res folder in Android Studio - and replace the App name with your new one in this line:
<string> string name="app_name"> bCard </string>


Change the Package Name
Follow these steps:

  1. In the Project panel on the left side, click on the little gear icon.
  2. Uncheck the Compact Empty Middle Packages option.


  3. Your package directory will get broken up into single directories, you will have to select each directory you want to rename and do these steps for each one:
    • Right-click on it
    • Select Refactor
    • Click Rename
    • In the Pop-up dialog, click on Rename Package - DO NOT click Rename Directory!
    • Enter a new name and click Refactor
    • Android Studio will update the changes, it may take up to 30 seconds, usually less, just wait for AS to be done.
    When renaming a com directory, Android Studio might show a warning. In this case, select Rename All.


    In case you have integrated Firebase in your project (for Firebase Cloud Messaging or other services), you must also change the "package_name" string into the google-services.json file accordingly to the new package name you've just set in Android Studio, as shown the the picture below.
    NOTE: The google-services.json file is usually located in the app folder of your project folder.


  4. Open build.gradle in Android Studio and rename the applicationId string into your new full package name, then click Sync Now on the top-right corner, it's usually highlighted by a yellow bar.
  5. Wait for build.gradle to be done. if it doens't print any error in the Android Studio console, then you've successfully renamed your package name.


  6. Reskin the app/change icons
    This project has .xml files - stored into the res/layout folder - where you can edit all Views, Buttons texts, TextView's strings and all views positions, font colors, size, etc.
    Alert messages are located in the code, they can be edited only in the .java files.


    Terms of Use and Privacy Policy
    Select the tou.html file form the assets folder in Android Studio and edit it accordingly to your own Terms of Service and Privacy Policy. Also replace the APP_NAME words with the new name you assigned to your App.
    Please also pay attention to this line:
    "mailto:support@yourdomain.com">support@yourdomain.com
    

    There are a few identical lines like that in the tou.html file, so you must replace support@yourdomain.com with a valid email adress where people can contact you for any question, feedback or in case they want to delete their account.


    Delete a User's account upon request
    Accordingly to GDPR Terms, you have 24 hours to delete an account after receiving a deletion request. In order for you to delete an account, you first need to identify the user's row in the User class of your Parse Dashboard, keep a note of its objectId value, select that row and click Edit -> Delete this row.
    Then, just search for that objectId value you've previously noted in all the other Classes of your database, check out all the rows until you'll find that objectId and delete it - this is in case it appears into some Array-type columns.


Configurations

The strings.xml file
You can find this file into the res/values folder in Android Studio. Open this file and keep reading this guide, you'll have to perform some edits in this file in order to get your template ready to run:

App Name
Replace the following name with the new one you want to give to this app in this line:
<string> string name="app_name"> bCards </string>




The Configurations.java file
Open this file from Android Studio and keep reading this guide, you'll have to perform some edits in this file in order to get your template ready to run:

Parse Server Keys
As explained in the Quick Start section of this guide, you must replace the strings of the 2 variables below with your own App Id and Client Key that you will get from the back4app website after creating your own Parse App:
    public static String PARSE_APP_ID = "K7SCPO9S6zywk3DMoEskABkJCOOWNkwx6Lfew2hy";
    public static String PARSE_CLIENT_KEY = "kC36ZLG7UWs31cPpLUN3M8RkS6K6BK544MFYm3hD";

Custom colors
You can edit the HEX values of the following variables as you wish. The main color of the app and some other Views will be affected by your change:
    public static String MAIN_COLOR =  "#f54b8f";
    public static String LIGHT_GREY = "#FFF8F8F8";
    public static String GREY = "#bababa"

PLEASE NOTE that not all views will be affected by changing the HEX values above, you may still need to go through some XML file and adjust the colors on your own with the right-side Attributes panel.

Custom fonts
This App uses some custom fonts for Buttons, TextViews ans EditTexts. The font files are stored into the app/src/main/assets/font folder and are declared in this line:
public static Typeface osBold, osSemibold, osRegular, osExtraBold, osLight, osItalic;

Such fonts are initialized into the onCreate() function as follows:
    osSemibold = Typeface.createFromAsset(getAssets(),"font/OpenSans-Semibold.ttf");
    osRegular = Typeface.createFromAsset(getAssets(),"font/OpenSans-Regular.ttf");
    osExtraBold = Typeface.createFromAsset(getAssets(),"font/OpenSans-ExtraBold.ttf");
    osLight = Typeface.createFromAsset(getAssets(),"font/OpenSans-Light.ttf");
    osItalic = Typeface.createFromAsset(getAssets(),"font/OpenSans-Italic.ttf");

In case you want to add a new font, you have to first drag your .ttf or .otf font file into the app/src/main/assets/font folder, then you have to instantiate it at the end of the public static Typeface line that's into the onCreate() function - let's pretend you have a font file called Helvetica-Bold.ttf, you may add an instance called hBold (it's just an example, name it as you wish since it's a variable):
public static Typeface osBold, osSemibold, osRegular, osExtraBold, osLight, osItalic, hBold;
Lastly, import its path into the onCreate() function like the existing ones. Based on the font example above, your new line of code may look like this:
hBold = Typeface.createFromAsset(getAssets(),"font/helvetica-Bold.ttf");

Admin email address
Once buyers will place orders in the app, both you and them will get an email with a recap of the order, so you must set a valid email address by replacing the string of the following variable with your own one:
    public static String ADMIN_EMAIL_ADDRESS = "admin@yourdomain.com";


URL path of the PHP files
In order for you and the buyers to get Orders recap emails, you must first upload the 2 PHP files included in the PHP folder into your own server - you can use FileZilla to do that and you must own a domain with PHP 5.4 or higher enabled.
Then repalce the string of this variable with the URL of the folder where you've uploaded the email-admin.php and email-buyer.php files:
    public static String PATH_TO_MAIL_PHP_FILE = "http://xscoder.com/zstore/"

PLEASE NOTE that if you uploaded those 2 PHP files into the root of your server (usually it's the public_html directory), then the URL you must set should be something like http://yourdomain.com/
Otherwise, if you've uploaded those PHP files into a directory, your URL can be something like http://yourdomain.com/yourfoldername/
IMPORTANT: Always place the slash symbol / at the end of your URL string!

Default Currency Code
Based on where you are located (but mostly where your PayPal account is located at), you have to set the default Currency Code by replacing the string of the following variable into your own coyntry's currency code:
    public static String CURRENCY_CODE = "USD";

Just for your reference, here's a list of all ISO 4217 Codes: https://www.xe.com/iso4217.php


Default Delivery price
Since Z Store's' concept is about selling physical products, you will have to make shipments to deliver goods to clients. So you can set your default delivery price by changing the number of the following variable:
    public static double DELIVERY_PRICE =  7.90;


Default estimated delivery days
You can change the estimated delivery days for when goods will be delivered to buyers in the following variable:
    public static int DEFAULT_ESTIMATED_DELIVERY_DAYS =  2;

Based on this value, after a buyer will make a purchase, the App will show him an estimated delivery date in the Orders screen.


Courier tracking URL
You will surely choose an international courier for shipping goods, such as DHL, UPS, etc. So you must find the page relative to the shipment's tracking on their websites and replace the string of the following variable with that URL:
    public static String COURIER_TRACKING_URL = "https://www.dhl.it/en/express/tracking.html";

Please check that link on your browser in order to see what kind of page you have to look for on your Courier's website.


Merchant Name
Set your own Store or comapny name by replacing the string of thew following variable with your own name:
    public static String MERCHANT_NAME = "Z Store Inc."


Parse Dashboard Classes and Utility functions
This section is a list of strings that the app calls to perform queries to the Parse Server database - aka Parse Dashboard - and it contains a few useful custom global variables and functions.
Do not edit those variables and instances unless you're an experienced Android developer, otherwise the app will not work properly.

Braintree PayPal SDK

PLEASE NOTE that you need a PayPal Business account in order to use Braintree, you can switch your Individual account into a Business one anytime form your PayPal account page.
Follow these steps:
  1. Login into your PayPal developer Dashboard with your Paypal credentials at https://developer.paypal.com/developer/accounts/

  2. Click Accounts in the SANDBOX section and then click Create Account

  3. Fill all the required fileds in the Create Sandbox Account page as you wish, just remember to put a fake email address in the Email Address filed and to select Business (Merchant Account) option.
    Click the Create account button when you're done.

  4. Braintree Sandbox account: Go to https://sandbox.braintreegateway.com/ and Create your Sandbox account
    Once you have signed up and verified your account, enter the Dashboard and click on Settings -> API Keys
    Click on the Generate New Tokenization key button, and once the website has generated it, copy that Key and use it to replace the string in this variable into Configurations.java:
       public static String SANDBOX_TOKENIZATION_KEY = "sandbox_3js4q98q_9jt3psrv9f6x3c6n"; 
    



  5. Braintree Production account: Go to https://www.braintreegateway.com/ and create your Production account
    Once you have signed up and verified your account, enter the Dashboard and click on Settings -> API Keys
    Click on the Generate New Tokenization key button, and once the website has generated it, copy that Key and use it to replace the string in this variable into Configurations.java:
       public static String PRODUCTION_TOKENIZATION_KEY = "production_xzxnzz7k_ytspsp9gbgwj8bz9";
    



IMPORTANT: BEFORE SUBMITTING YOUR APP TO THE APP STORE, you must switch the value of the tokenizationKey variable into PRODUCTION_TOKENIZATION_KEY.
In order for you to do that, simply enter the Configuratoins.java file, uncomment PRODUCTION_TOKENIZATION_KEY and comment (or delete) SANDBOX_TOKENIZATION_KEY on the top of the file.
So the tokenizationKey variable should look like this:
   public static String tokenizationKey = PRODUCTION_TOKENIZATION_KEY;
You'll also need to complete your Production account on Braintree by inserting your business detauils and bank account credentials, in order to be able to receive payments from Braintree. You should see an alert badge next to the Account button in your Braintree Production page, so click it and complete your Business profile by following the instructions provided by the website.


Database

You should perform the following configurations BEFORE running the app!
The backend of this template is Parse Server hosted on back4app.com.
After performing the configurations mentioned below, you will run the app and see no content, the Intro screen will show up and you'll be able to Sign Up in order to create a test account and start testing the app.

Due to the high-performace code of this template and the FREE back4app plan's limits, you will be able to test this template for a while, but it may happen that you'll receive an email from back4app telling you that you have reached the monthly plan's limits and you should upgrade your plan.
I suggest you to do that and just subscribe for a Starter Plan - it' only $4.99/month - so you will get more Database Storage and API requests/second/month than the FREE Plan. This paid subscription will also increase the loading speed of the app and can be enough for a good amount of users using your app. Check out the pricing table here
So, follow these steps to setup your own database:
  1. Unless you already have an account on back4app.com, create one - it's FREE!
  2. Enter My Apps and click on Build new app:

  3. Type your App name and click CREATE:

  4. Wait for the website to create your app - it'll take just a few seconds - then you'll be redirected to the Dashboard (the database interface, which looks like an Excel file):

    You'll see it empty, but don't worry, it'll get data while you'll start using your template.

  5. Click on Server Settings from the left side menu:

  6. Click on SETTINGS in the Core Settings box:

  7. In the following page, you'll have to copy the App Id and Client Key, and replace the strings into Configurations.java - as mentioned already in the Quick Start section of this guide:

        public static String PARSE_APP_ID = "pwkmVrsiHTp2wN3q3UXUBiOwiE5C31atCq2CihPy"
        public static String PARSE_CLIENT_KEY = "ugVWfJTY4azulDWoXmHVnkHkidlDzw6koSzrEVha"
    


  8. Click the BACK button on the bottom of the page to go back to your App Dashboard, then click SETTINGS in the Cloud Code box:

  9. Click on + ADD and navigate to the folder you've downloaded from codecanyon in order to upload the main.js file to back4app.
    Once main.js has been uploaded in this section, you can check it out by simply clicking its name from the cloud directory - if you can see its code in the blue area on the right side, it means the upload has been successful.
    Click the DEPLOY button and wait for a success alert, then go back to your App Dashboard by clicking Server Settings from the left side menu.

    main.js is a Javascript file that is absolutely useful for this app, since it allows it to perform some custom functions, so don't forget to upload it into the Clod Code section ;)
  10. Good job, your app is now connected to your own database and you can finally run and test it.
    As explained in the Quick Start section of this guide, you should shortly get an alert after running the app for the first time that warns you that the Categories and Products classes have been created.

    Enter the awesome Parse Dashboard and check your database out.

    PLEASE NOTE: If you already bought the iOS verison of this template, you don't need to create a new Parse App, nor upload the main.js file in the Cloud Code section.
    Just add the App ID and Client Key strings into Configurations.java and you'll be fine.
    The power of Parse Server is that you do not have to manually create tables and columns in the database - like you would have to do in MySQL - because the SDK will automatically create Classes and columns in your Parse Dashboard while using the template!

ADD CATEGORIES AND PRODUCTS IN THE DATABASE

Follow these easy steps to add/edit Categories and Products rows in your databae using the powerful FREE Adminca panel for Parse Server apps:

  1. Go to adminca.com and Sign up for a FREE account - it's FOREVER FREE, so don't worry and go ahead.
  2. Watch this video to learn how to setup your own Admin panel and edit/add data:
Due to the structure of the database, it's not possible to make any bulk upload, you must manually add Categories and Products data.

Facebook login

  1. Enter your Facebook Developer page at https://developers.facebook.com/apps/
  2. Click + Add a New App

  3. Type the name of your app and your contact email address in the popup window that just showed up.

  4. Click the Create App ID button and pass the Security check that Facebook will promt out.
    After that, the browser will show your Apps Dashboard.

  5. Click on Settings -> Basic in the left-side menu.
  6. In the Privacy Policy URL type your website's URL.
    If you don't have any Privacy policy page loaded in your own server or website, don't worry about it, you may either create one and upload it to a free hosting server like 000webhost.com or just place any URL, even "http://example.com/", is ok, Facebook staff doesn't make ay check for it yet. of course it would be good to create and upload a Privacy Policy HTML or PHP page someday in your own server and change that URL with the one of your page :)
  7. Select a Category, upload a 1024x1024px or 512x512px app icon image and click Save Changes on the bottom of the page.
    Ignore the Business Use and Data Protection Officer Contact Information sections in case you're not doing any business in Europe (this is intended for companies, not indiviual developers or people).

  8. Scoll down and click + Add Platform, then select Android:

  9. Copy the package name you have set before in Android Studio and paste it in the Google Play Package Name box of the Android section.
    Type Intro in the Class Name box.
    Go back to Android Studio and run your app. You have to be logged out the app in order to enter the Intro screen and check your Logcat. You should see a message like this:
        I/log-: HASH KEY TO COPY: U05jRHlAyYvJZCAuPfKI+/l6fzQ=
    

    You have to copy only the U05jRHlAyYvJZCAuPfKI+/l6fzQ= part and paste it into the Key Hashes box.
    Lastly, switch Single Sign On option to Yes and click the Save Changes button on the bottom of the page.

  10. Click the OFF switch on the top-right corner of the page.
    Click the Confirm button in the alert that shows up - you can ignore its message, the Facebook Login will still work in your template:

  11. Now go back to your App Dashboard on back4app, scroll down and click SETTINGS in the Facebook Login box:

  12. Paste your Facebook App ID in the text box and click the + button to add it to your Parse App.

  13. Enter the strings.xml file in Android Studio - it's inside the res/values fodler - and replace the facebook_app_id value with your own Facebook App ID - you can copy it by clicking on the APP ID on the top of the screen:

    Into strings.xml:
    <string name="facebook_app_id">228126361127891</string>    
    


  14. Great, you're done with the Facebook Login settings!
PLEASE NOTE that if you already bought the iOS verison of this template, you don't need to create a new Facebook app.
Just add the Android platform to your existing Facebook App, perform the settings explained above and copy the same APP ID.

Push Notifications

This app sends and receives Push Notifications while interacting with posts, comments, likes, etc.
Follow these steps to create a Firebase project and grab the GCM Sender ID and Server Key strings, in order for the app to send/receive Push Notifications:

  1. Login into your Firebase account and click on + Add project.

  2. In the popup window that will show up, enter your app name.
    Select the country where you live in.
    Check the Use the default settings for sharing Google Analytics for Firebase data option.
    Check the I accept the controller-controller terms option as well.
    Then click Create project

  3. When Firebase has created your project, click Continue.
    On the top-left corner of the page, next to Project Overview, click the gear icon and select Project settings from the menu.

  4. In the Settings page, click the Cloud Messaging tab, here's where you can copy the Sender ID and Server Key.

  5. Enter your App Dashboard on back4app and click on SETTINGS in the Android Push notification box:

  6. Click Edit, paste your Sender ID in the GCM Sender ID box and your Server key in the API key box.
    Lastly click the Next button:



  7. It's now time to go back to your Android Studio project and open AndroidManifest.xml by selecting it from the files menu list on the left panel - it's in the manifests folder.
    You will see a few comments like this:
        IMPORTANT: REPLACE "com.xscoder.penpals" WITH YOUR OWN PACKAGE NAME 
    

    Just do what they say, which means that you have to replace the original package name with your new one (I assume you already changed the package name, but in case you haven't done that yet, do it now, then keep reading).

    Then, you'll have to replace the demo GCM Sender ID string with your new one from your Firebase project, so find that line with this comment:
        IMPORTANT: Replace "191162618244" with your own GCM Sender Id. 
    

    and just replace the Sender ID in this line:
        android:value="id:191162618244"/>
    


  8. You must also replace the Sender ID into Home.java as well, so open that file, find the following code into the onStart() function and replace the Sender ID string:
        installation.put("GCMSenderId", "191162618244");
    


  9. You're now all set with Android Push Notifications!

    Now, as the Admin of the app, you can send Push Notifications messages to all registered users by using the Push console in your back4app's Parse Dashboard:

    All those users who have allowed Push Notifications in their devidces and have the app open or in background, will receive your Push messages.

    If you already signed up with some test users in your app - so you've ran the app before doing these Push Notifications configuration steps - then you will have to sign up as a couple of new test users and run the app again in order to test Push Notifications. This is because the previous test users you created have not been registered in the Installation Class in your Parse Dashboard. That's the Parse Server's Class that handles Push and it needs to have the ID of users who allowed Push Notifications on their devices at app startup.

Useful stuff

F.A.Q.

Parse Server hosted on back4app
Parse Server is a powerful JSON backend based on Node.js, and its hosted on back4app.com.
Click here to learn more about this backend

Can I host Parse Server on my own server?
Yes you can, but I do not provide support for it, because it's hard to get Push Notifications and Cloud Code jobs done, that's why my templates use back4app.
You should refer to the official Parse Server Guide at parseplatform.org

What kind of support is offered?
Free support is offered in case of bugs encountered in the original template, either in the code or the UI design.
In case you have edited the code - and so created bugs because of your editing - I may apply some fee to fix your bugs by a remote connection through TeamViewer, or by you sending me your source code for verification.

Should I use Android Studio to edit this template?
yes, you must always use the latest stable officlal version of Android Studio to edit this application.
Download the latest version here: Download Android Studio

I've performed all configurations mentioned in this Guide, but something is wrong. What should I do?
• Double check all your configurations, probably you have missed something.
• Make sure you've uploaded the main.js file in the Cloud Code section on back4app.
• Always check the Logcat in Android Studio if the app crashes, ususally the error messages are shown in red color.
The Logcat helps debugging your app, it's really important


What hosting provider is best?
Based on my experience, GoDaddy is the best hosting/domain provider ever so far. The demo website files of this template are hosted on GoDaddy, fair prices and stable servers.

Support | Requests