Documentation

Estimated reading time: 8 min

Introduction

AndroidEcommerce app built with native Java in Android Studio. It’s complete mobile ecommerce app solution for android devices with advanced CMS. It offers more than 35 pages and all are fully designed & keeping in mind to fit for any product types. It’s best app for any type of store like Fashion, Electronics, Grocery and Restaurant. It is fully rich featured application that offers all required features, that can fulfill any modern application. It’s easy to customize, you can customize any page as per your needs. It follows all the standards to fulfill customer’s requirements.

Why This App?

There are lot of reasons you should choose this application for

  • CMS for managing overall store activities
  • Easy to install
  • Easy to customize
  • Super friendly code
  • Well commented code
  • Design to fit any product types
  • Basics knowledge for setup
  • Equip with all modern features
  • Multiple themes for app home and category screen
  • Just choose design you like and go

Tools & Technologies

App build with latest tools using advance techniques fulfilling all the needs of modern app.

  1. Android Studio is the official Integrated Development Environment (IDE) for Android app development, based on IntelliJ IDEA. On top of IntelliJ’s powerful code editor and developer tools, Android Studio offers even more features that enhance your productivity when building Android apps.
  2. Gradle is an advanced build toolkit, to automate and manage the build process, while allowing you to define flexible custom build configurations. Each build configuration can define its own set of code and resources, while reusing the parts common to all versions of your app. The Android plugin for Gradle works with the build toolkit to provide processes and configurable settings that are specific to building and testing Android applications.
  3. Laravel is a powerful and most popular framework that emphasizes flexibility and expressiveness. Laravel is a free, open-source PHP framework, intended for the development of web applications following the model–view–controller (MVC) architectural pattern.
  4. Firebase Cloud Messaging provides a reliable and battery-efficient connection between your server and devices that allows you to deliver and receive messages and notifications on your mobile device. Using FCM, we can send notification messages to drive user re-engagement and retention.

Installation Video Tutorial

We have created App Installation Video Tutorial for you.

Please see references in the video description before watching the video, if you don’t know how to get SHA-1 or Hash Key and how to integrate Facebook, Google, FCM, OneSignal and AdMob in your Android App.

Installation – Laravel CMS

First of all you need to setup your ecommerce store admin panel. Please follow step by step instructions below.

Server Requirements

The Laravel framework has a few system requirements. Of course, all of these requirements are satisfied by the Laravel Homestead virtual machine, so it’s highly recommended that you use Homestead as your local Laravel development environment.

However, if you are not using Homestead, you will need to make sure your server meets the following requirements:

  • PHP >= 7.0.0
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • Mbstring PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension

Make Sure you got the server that fulfill above all requirements.

Laravel Source Code Setup

Now open the folder name (Laravel CMS Source Code) inside the downloaded package.

Inside the folder you will find all the server side code.

app folder contain logical code, routes and controllers .

resources folder contain the assets and views.

 

 

Mysql Database Setup

Open folder with name Database inside downloaded package. Goto Phpmyadmin And import the .sql file to your sql database.

Now open .env file inside the Laravel CMS Source Code folder and change the following

  • DB_DATABASE=’database name’
  • DB_USERNAME=’user name’
  • DB_PASSWORD=’password’

Upload Files & Settings

Now upload all files to the root of your domain.

Now Open link http://your-domain/admin/login

username: demo@android.com

password: admin

General Settings

After Login go to the Site Setting section. And change the settings according to your requirement.

  • Currency Symbol
  • New Product Duration
  • Display Cart Button
  • Facebook App ID
  • Facebook Secret ID

To get facebook id and secret id please follow this link

  • Push Notification Setting (FCM) — App Key
  • Push Notification Setting (FCM) — Sender Id

To get sender id and app key please visit

  • AdMobe — App Key
  • AdMobe — Add Unit Id

To get AdMobe App Key please visit

  • Phone Number
  • Address
  • City
  • State
  • Zip
  • Country
  • Latitude
  • Longitude
  • Local Notification title and text

Setting Shipping Methods

Go to the shipping methods section from the admin panel and setup your shipping methods.

http://your-domain/admin/shippingMethods

Setting Payment Methods

Go to the Payment Methods section from the admin panel and setup your desire payment methods.

http://your-domain/admin/paymentSetting

Installation – Android Mobile App

After CMS installation, please follow below instructions to set up your mobile application.

Getting Started

Download and install all latest tools, required for developing Android apps such as Java Development Kit and Android Studio as the Official Android IDE. For updated tutorial about how to install them, you can see and Download from Android Developer website.

Android Studio Setting

There are three main things interacting when you use Android Studio to create android applications.

  • The code you write in Java or Kotlin to create interactive android apps
  • Android Studio itself, an IDE that provides you with a nice interface for coding
  • Android SDK, a selection of tools including the Android platform itself

Now you can click on Android Studio to launch it. Once it opens up, you’ll be presented with a menu where you’ll be able to get started or configure some options. The great thing is that everything is handled for you at this point, though you may want to familiarize yourself with the SDK Manager (Configure > SDK Manager) which is where you’ll update your Android SDK to support newer versions, as well as download things like code samples or support for Google Glass. But don’t worry about that now but if Android Studio says you’re missing something, this is where you’ll probably need to go to find it.

Import Project in Android Studio

Locate your Android app in the given project zip folder

    • Open Android Studio > Import Project (Eclipse ADT, Gradle, etc.)

    • Browse to directory where you place “AndroidEcommerce” project and click OK.

Rename App Package Name

    • First click once on your package and then click setting icon on Android Studio.
    • Close / Unselect “Compact Empty Middle Packages”
    • Then, right click your package and rename it.

    • Right click on the root folder of your project.
    • Click “Open Module Setting”.

    • Go to the “Flavors” tab.
    • Change the Application ID with same name of your package.

  • Clean and Rebuild your project.

Change Package Path in the Code

  • Right click on customs package and click on Copy Reference to copy the path of the package
  • Find CustomListView and change the given path as yours in the files
    • layout_categories_6.xml
  • Find CustomViewPager and change the given path as yours in the files
    • product.xml
    • homepage_1.xml
    • homepage_2.xml
  • Find AppBarFlingScrollBehavior and change the given path as yours in the files
    • news.xml
    • homepage_1.xml
    • homepage_2.xml
  • Find CircularImageView and change the given path as yours in the files
    • signup.xml
    • settings.xml
    • activity_main.xml
    • update_account.xml
    • layout_categories_5.xml
  • Clean and Rebuild your Project.
  • If it gives error again, change the path in the relevant files also.

Google and FCM Configuration

  • Register your app project on the Google API Console and Get Google API Key
  • Import your Google project to Firebase following these guidelines.
  • Integrate FCM to your android project as mentioned here.
  • Download the google-services.json config file of your FCM project.
  • Replace new google-services.json file with existing at app > google-services.json

It is very important to import a Google project with Maps API enabled, to Firebase as we need both Google Maps and FCM services in android app.

Facebook and Google App Key

Get Facebook Key and Google Key and change both in strings.xml

Admobe Integration

To Integrate Admobe in your app, follow this link.

It is very important to link the Admobe Apps to existing Firebase Apps as we also need FCM services in our app.

OneSignal Integration

To Integrate OneSignal in your app, follow this link.

  • Sign up for an OneSignal account.
  • Setup your Google Server API Key and Sender ID on OneSignal.
  • Get your OneSignal App ID.
  • Go to Admin Panel and open SiteSettings page.
  • Change Default Notification to OneSignal.
  • Put your Onesignal App ID and Onsignal Sender ID (FCM Sender ID).
  • Open app > java > yourpackagename > constant > ConstantValues.java
  • Change DEFAULT_NOTIFICATION to onesignal.
  • Open build.gradle (Module).
  • Put your Onesignal App ID in manifestPlaceholders.
  • Clean and Rebuild your Project

Make sure that the Default Notification you selected in the Settings section in Admin Panel is same as the value of DEFAULT_NOTIFICATION in ConstantValues.java in Android Studio.

Change Server URL in Application

Select app > java > yourpackagename > constant > ConstantValues.java

Debug Application

Android Studio provides a debugger that allows you to do the following and more:

  • Select a device to debug your app on.
  • Set breakpoints in your Java, Kotlin, and C/C++ code.
  • Examine variables and evaluate expressions at runtime.

This page includes instructions for basic debugger operations.

Test Application

Android Studio is designed to make testing simple. With just a few clicks, you can set up a JUnit test that runs on the local JVM or an instrumented test that runs on a device.
To test your app, follow some guidelines mentioned here.

Create Release APK

To release your application to users you need to create a release-ready package that users can install and run on their Android-powered devices. The release-ready package contains the same components as the debug APK file — compiled source code, resources, manifest file, and so on — and it is built using the same build tools. However, unlike the debug APK file, the release-ready APK file is signed with your own.

Follow this link to create a release APK, sign your app and to publish on Google Play Store.


FAQ’s

Q: How to change Application Icons?
Ans: Change all launcher icons in app > res > mipmap > ic_launcher.png


Q: How to change Application Name?
Ans: Select app > res > values > strings.xml


Q: How to change Application Colors?
Ans: Change colors as you need in app > res > values > colors.xml


Q: How to change Splash Screen of App?
Ans:You can easily change splash screen by following steps:

  • Add your splash images in app > res > drawable > splash.png
  • Modify res > layout > splash.xml as you need


Q: How to change Intro Slides of App?
Ans: You can change intro slides by following steps:

  • Add your intro images in app > res > drawable
  • Modify intro_slide_1.xml layout as you need
  • Modify Slide title and description in all strings.xml files
  • Modify other intro slide layout files according to your requirement
  • Add your customized slides to activities > IntroScreen.java

For more customization visit AppIntro, as IIntroScreen Iextends AppIntro.



Q: How to add or remove items from the Navigation Drawer (left menu)?
Ans:You can easily change it by following steps:

  • Open activities > MainActivity.java
  • Go to the function setupExpandableDrawerList()
  • Add or remove new Item in the List “listDataHeader”


Q: How to add new Language in the App?
Ans: Add a new resource file res > New > Android resource file

Name it as strings and choose Locale as Qualifier. Select a language you want to add and choose Any Region for it.

Open the newly added strings.xml file. Copy any string from other language’s strings.xml file and paste it in the strings.xml of the new language.

Open Translation Editor res > values > strings.xml > Open Translations Editor

Enter all the values of required labels/keys in the newly added language in the editor.

Now go to Admin Panel and open Languages page. Click on Add Language button.

Enter all the required details of the language you want to add.

Make sure that the language code you entered in the language section in Admin Panel is same as the language code in Android Studio.

Was this article helpful?
Dislike 0
Views: 206