Customize Apps

In this article we will learn how to customize Nearby Shops android apps

Prerequisite Knowledge

To understand this guide you dont need to be an expert but having some basic knowledge of android development, android studio and java will help you. Even if you dont have this knowledge you can always hire an android developer and ask them to do this for you.

Requirements for Customization - What's Needed ?

1. Domain Name with backend API Installation
2. Brand Name and Brand Logo
3. Custom graphics and Illustrations (Optional)
4. Colors Scheme
5. API Keys for Integrations
6. Brand website with links to Privacy Policy, Terms of Service, FAQs, Contact and Credits

Requirements Explained

Backend api with a custom domain name

You need to have a backend installation with you domain name. For example you could have something like https://api.example.com . In this case you must have already registered your domain name "example.com". After that you would assign this domain name to your api server to access your api. As a final result you could have your api server running on. https://api.example.com.

Your brand name and brand logo

Please use your own brand name and brand logo distinct from nearby shops. Because nearby shops is a name of the product and not a service. Having your own brand name is good for you also because you get to create your own distinct brand image according to what suits you.

Custom Graphics and Illustrations - Optional

You can use your own custom graphics and illustrations in your app. Before using these illustrations in your app. Please ensure that you have rights to use these illustrations and you have studied all the legal licensing terms for their use.

Color Scheme

You can define your own color scheme for the app and choose your colors according to what you like and what suits you the best. You need to provide three colors. Color primary, color primary dark and color secondary. These are the theme colors for the android app. You can choose your colors from https://www.materialpalette.com/ . This is a very good website which can help you choose your colors for your app.

API keys for Integrations

In order to activate SMS-OTP, e-mail, push notifications and Payment gateway you need to use third party services. The tutorials for third party integrations are already provided in the integrations guide. You can read those tutorials and integrate third party services.

Links to website, policies and credits

Each app contains links to your website, privacy policy and terms of service and other sections like credit section. When you're customizing your app. Make sure to put our own custom links.

Steps for Customization

1. Change app Package name
2. Change API Server URL and set multi-market mode to false
3. Change brand name and logo
4. Change color scheme
5. Change empty screen graphics (optional)
6. Setup Third Party Integrations
7. Setup website links

Let us begin the step by step guide for how to customize your android apps

Common Tasks

Nearby Shops comes with three android apps. One for end-user, one for shop-owner and another one for admin. For each app you need to download the app source code by cloning the github repository. After cloning the repository you can now open the project with the latest version of android studio. You can use android studio to do all the customizations.

Step 1 : Change app Package name

If you want to publish your app on the google play store. You must be aware that each app needs to have a unique package name because on google play store the app's package name acts as a unique identifier for the app.

To ensure that you have a unique package name we recommend that you purchase a domain name and be an owner of that domain name. And use that domain name as a package name for your app. This is not a mandatory step but its a best recommended practice to ensure that your package name remains unique so that you dont face legal hurdles and issues in future.

Given below are some really good tutorials on how to change your package name and they are good enough to give you an idea for how you can change your package name.

https://stackoverflow.com/questions/16804093/rename-package-in-android-studio

https://abhiandroid.com/androidstudio/how-to-change-package-name-android-studio.html

You can just see more of such tutorials by typing "change package name android" on any of your favourite search engine.

If this is not sufficient and you're still unable to do this step feel free to get in touch with the community at our forum.

Step 2 : Change API server URL and set Multi-Market mode to false.

Your app needs to be connected to your own backend not the other one. In order to ensure its connected to your api backend you must change the url for api server. The url for API Server is defined as a static constant in the file with name "PrefGeneral.java". You need to search for this file in the android app project and update the URL.

The constant DEFAULT_SERVICE_URL should be equal to your service URL and multi-market mode should be set to false. This will ensure that your app works in single market mode and connects with your api.

If you want to learn about multi-market mode you can learn more about it in our installation tutorial.

Step 3 : Change Brand name and Logo

Having your own brand name is good for you also because you get to create your own distinct brand image according to what suits you. To change your app name and you need to look for strings.xml file in the android app project. This file contains a string with name "app_name". Here you can put your own app name.

To change your brand logo. save your logo into the drawable folder and then go to manifest.xml file ... look for icon attribute and change it to point to your own brand logo.

If you face any problem feel free to get in touch with us on our forum.

Step 4 : Change Color scheme

You can define your own color scheme for the app and choose your colors according to what you like and what suits you the best. You need to provide three colors. Color primary, color primary dark and color secondary. These are the theme colors for the android app. You can choose your colors from https://www.materialpalette.com/ . This is a very good website which can help you choose your colors for your app.

You can define your custom color scheme in your style.xml file.

Step 5 : Custom graphics and Illustrations

You can use your own custom graphics and illustrations in your app. Whenever you feel appropriate. Before using these illustrations in your app. Please ensure that you have rights to use these illustrations and you have studied all the legal licensing terms for their use.

Step 6: Setup third party integrations

In order to activate SMS-OTP, e-mail, push notifications, maps and Payment gateway you need to use third party services. The tutorials for third party integrations are already provided in the integrations guide. You can read those tutorials and integrate third party services.

Step 7 : Setup links to website, terms of service and privacy policy

Each app contains links to your website, privacy policy and terms of service and other sections like credit section. When you're customizing your app. Make sure to put your own custom links.