“MyCrm - Android Mobile Application” Documentation by “SoftGain” v1.0.0


“MyCrm - Android Mobile Application”

Created: 26/11/2021
By: SoftGain
Email: softgainweb@gmail.com

Thank you for purchasing my theme. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form here. Thanks so much!


Table of Contents

  1. Configuration File
  2. Java Structure
  3. XML / Layout Structure
  4. Dependencies
  5. Credits

A) Configuration File - top

Just in case if You want to try this theme without back end server, feel free to use my demo back end server at https://mycrm.soft-gain.com/api/. If You want to use Your own back end server, please change RestClient.java file (see image below). Also if Your back end server using https protocol, do not forget to change the CertificatePinner. (please refer: https://www.ssllabs.com/ssltest/ to get Your sha256 CertificatePinner).

Configuration File

Also if You need MyCrm postman collection for testing purpose, it available here https://drive.google.com/file/d/1XJe33g5HP4PQc0p6wDYAJGCjqRTICxgu/view?usp=sharing.


B) Java Structure - top

For my java files, my main activity is SplashActivity.java (its just showing a simple splash screen). Inside SplashActivity there is an if statement, if You already login it will bring You into MainActivity.java (it will show You a home page), if not it will bring You into LoginActivity.java (it will show login form).

There are few folder / package for my java files structure:

  1. Activity: here are listed all of Your activity for each module. Every time You click or move into a new interface, You will come to here first. Inside activity You will have 2 fragment, FormFragment (it will show You a form) & ListFragment (it will show You a list of Your data).
  2. Adapter: list of all Your adapter for each module.
  3. Api: there just two files here, RestClient.java & ApiInterface. RestClient.java is Your apps configuration file, in this file You can change Your end point back end server, also You need to build a CertificatePinner here if Your back end server using https protocol. While ApiInterface is a list of all Your Api method.
  4. Auth: inside Auth package, You can find LoginActivity.java (activity for login page) & ForgotPasswordActivity.java (activity for forgot password). For forgot password, You will recieve link to reset password in Your email and this link will bring You into reset password form on MyCrm website version (if You purchase this theme without its back end service, You need to change this reset pasword form into Your own).
  5. Fragment: as i mentioned before, inside this package You will have two files, FormFragment.java & ListFragment.java. Inside this fragement, You will find all method to makes Your form and list to work.
  6. Model: here is list of all Your model to representating data on adapter for each module.
  7. Utils: inside Utils, You will find a file named Helper.java. Helper class will be used to store re-useable method.
Java Structure


C) XML / Layout Structure - top

For xml structure, i use default structure from android studio. What You need to know is i am using prefix for naming my xml files. For example i use prefix activity_ for activity layout files, or prefix fragment_ for fragment layout file etc.

In this theme i have some tab layout view. For this part i use 2 reusablde XML file, fragment_log.xml and fragment_comment.xml.

Java Structure

For hidding and showing content, i use some simple logic here. You can find method called initTabLayout() inside fragment where this tab layout is displayed.

Java Structure

For assets such as image, icon, background etc. I store its inside drawable package.

Java Structure


D) Dependencies - top

I've used some dependencies on this theme, mostly is just an ordinary dependencies that You will find on another android apps. Please check image below for detail.

Java Structure


E) Sources and Credits - top

Mostly i've used image and vector assets that available default on android studio (to preventing copyright issue).


Once again, thank you so much for purchasing this theme. As I said at the beginning, I'd be glad to help you if you have any questions relating to this theme. No guarantees, but I'll do my best to assist. If you have a more general question relating to the themes on ThemeForest, you might consider visiting the forums and asking your question in the "Item Discussion" section.

SoftGain

Go To Table of Contents