LiveX
Documentation

## Get Started

Thank you for purchasing our app

Please read the documentation carefully , and if you have any question check us .

#### Must Read this:

After purchase if you run the project and test the build in phone it will not work becuase you have to setup the Web API first then app will be works fine.
Web API is in Node.js

## Key Package Required

The Purchased Key & Package Name of your app Must be required for Authentication.

Register your package name to CodderLab.Contact Us

## Prerequisites

- VPS / Dedicated server
- Node
- NGNIX (preferred)
- Mongo DB

## LiveX Preferred Hosting

- Digital ocean
- AWS

## Guide to Install and Setup Android Studio:

In order to start configuring , you need to install Android studio and the 'Java SE Development Kit'. First download the android studio from here Android Studio

### Installation Guide:

#### Step 1

firstly, Head over to this link to get the Android Studio executable or zip file.

#### Step 2

Then click on the download android studio button.

Click on the “I have read and agree with the above terms and conditions” checkbox followed by the download button.

Then click on the Save file button in the appear prompt box and the file will start downloading

#### Step 3

After the download has finished, open the file from downloads and run it. It will prompt the following dialogue box

Click on Next.

In the next prompt, it’ll ask for a path for installation. Choose a path and hit next.

Note: The installation path should have the required minimum space.

#### Step 4

We will start the installation, and once it is completed, it will be like the image shown below.

then Click on Next

#### Step 5

Once “Finish” is clicked, it will ask whether the previous settings need to be imported [if the android studio had been installed earlier], or not.

It is better to choose the ‘Don’t import Settings option’.

Click the OK button

#### Step 6

This will start with Android Studio

android studio launch photo

Meanwhile, we will be looking for the available SDK components.

#### Step 7

Once it has found the SDK components, it will redirect to the Welcome dialogue box

Click on Next

Choose Standard and click on Next.

Now choose the theme, whether Light theme another the Dark one.

The light one is called the IntelliJ theme, whereas the dark theme is called Darcula.

Choose as required..

Click on the Next button

#### Step 4

Now it is time to download the SDK components

Then click on Finish .

So that It has started downloading the components

The Android Studio Is successfully configure. Now it’s time to launch and build apps

Last, click on the Finish button to launch it.

#### Step 4

Attention reader! Don’t stop learning now. Get hold of all the important Java and Collections concepts with the Fundamentals of Java and Java Collections Course at a student-friendly price and become industry-ready..

you are know how to change package name of the app in android studio? HERE

## SDK Manager

The installer , as also shown in the video should automatically download and install all required components . if you want to do manual setup , download at least the following components using the SDK manager

- SDK tools
- SDK platform Tools
- SDK Build Tools
- Google Play Services
- Android Support Library
- Google Repository
- Google USB Driver

You can download these SDK , if not installed already , using the SDK manager SDK Manager After you're done, you can open Android Studio and continue.

*Note: After successfully installing the Android Studio please make a sample app project to install necessary files into computer by android studio.

## Importing Android Project and Change Package Name

To import the app, simply open Android Studio and import/open the template. Make sure to wait for all the processes (the Gradle Build) to complete before continuing to the next step

#### Addition steps

Addition steps Sometimes, the Gradle Build fails. In some cases additional components are needed, Android Studio will ask you to do download these additional SDK components in the 'messages' tab, simply follow the instructions provided to install and download the additional components.

## Change App Name

Below is illustrated how you can change the name of the application.

Go to app->res->values->strings.xml

## Change Color Scheme

Below is illustrated how you can change the color of the application.

Go to app->res->values->colors.xml

You can change your apps colors to create a custom look. The primary color is the color of the Toolbar, some buttons and headers. The primary dark color is used for e.g. the status bar. get more color from here material.io

## Change Theme of Application

Above is illustrated how you can change the Theme of the application.

## Change App icon

Now we need to put a png file with your icon named 'ic_launcher.png' in the following folders:

Go to project location->Android source code->LiveX->app->src->main->

- res/drawable-mdpi - with a size of 48px x 48px
- res/drawable-hdpi - with a size of 72px x 72px
- res/drawable-xhdpi - with a size of 96px x 96px
- res/drawable-xxhdpi - with a size of 144px x 144px
- res/mipmap-xxxhdpi - with a size of 192px x 192px

this URL will help you resize your images or event create new icon to your app Launcher Icon Generator

## Change Splash Screen

We need to put a png file with named 'splash.png' in the following folder:

Go to project location->Android source code->LiveX->app->src->main->res->drawable

## Change API Links

BASE_URL should be "http://domain.com/mobileapp_api/"

API_BASE_URL should be "http://domain.com/mobileapp_api/api/"/

Click on app->java->com.packagename.appname->ApiClasses->ApiLinks

Above is illustrated how you can change the Rest Api link of the application.

## Change Package Name

## In-app Purchases

Above is illustrated how you can change the name of the application and change the AdMod ID.

Go to com.dinosoftlabs.LiveX.Users.Users_F file and search "case R.id.refresh_btn" here you can see the code which will be changed if you don't want to show the Subscription options.

    case R.id.refresh_btn: if(MainMenuActivity.purduct_purchase){
    											card_viewstack.reverse(); }
    											else open_subscription_view(); break;

## Firebase Configuring

## Enter SHA Key

if you did not change the firebase rules some of the app functions will not work like chat or save/change pictures.

if you not provide the SH1 key into the firebase project phone login and google login will not work you have to add you SH1 keys for both debug and live mode.

## Push Notification Cloud Function

#### Step 1

Go to the Cloud messaging and click on send your First Message

#### Step 2

Go to the Project Setting (refer below image)

Then Click onCloud Messaging and Copy the server key and paste into notepad (this is use in node js Project [backend])

## SetUp in App Purchase

#### Step 1

Enter Your Google play license key into Android code

Please refer below image

#### Step 2

First Generate Product in Google play console & give Product id (same as below image)

for set key go to the Admin panel and go to the plan page and click on new button

## Set Up Agora

#### Step 1

Open Agora console using this link

Generate Agora App ID

#### Step 2

Copy this Id and paste into Android code.

Please refer below image

#### Step 3

For use Live-streaming function you must be generate secret key in Agora console

## Debug and release Key

Before going to next you have to learn about the Sh1 key for both debug and release. if you are in the development mode then you will use the debug sh1 key but when you going to publish the app on playstore then you will have to use the sh1 key of Release key

#### Debug Key

#### Method 1 How to get the SH1 key for the published app (Signed or release key)

Follow the steps

#### Method 2 How to get the SH1 key for the published app (Signed or release key)

To get realese sh1 contains two step.

Step1: you will generate your own app signing key Create signing key

Step2: Get the Sh1 key of app signing key

Get the Sh1 key. Run the below command on Command Promt

keytool.exe -list -v -alias {alies name you set according to above toturial "key0" is the alies name} -keystore "{file adress of the key}" -storepass {password} -keypass {password}

## Google Login Configuration

Here is the Helping video for setup google login

#### Step 1

## Generate Debug Apk

Here is the Helping video for generating debug APK

#### Step 1

## Database Set Up

#### Step 1

Create a mongodb Atlas

use this link https://account.mongodb.com/account/register

- Click Sign up with Google.
- Enter one of the following identifiers for your Google account:
  - your gmail or Google Apps email address
  - the phone number associated with your Google account
- Click Next
- Enter the password for your Google account.
- then Click onNext
- Review and select the checkbox to accept the Terms of Service and the Privacy Policy.
- then Click onSubmit

#### Step 2

Deploy a free tier cluster

- Create new cluster (starting at free)

- Click on Create cluster

#### Step 3

- After creating Cluster Click on Connect button

- Click on Add your current IP Address

And then Click on Add IP Address

- Create Database User

Enter your Username and password then click on create database user.

- Click on Choose a connection method Button.
- Connect using MongoDB compass

- Then Click on I do not have MongoDB Compass and then click on Download Compass and copy Connection String and paste it into notepad.

- Then Open above installed MongoDB Compass and paste Copied Connection String and click on connect button.
  Ex: mongodb+srv://root:root123@cluster0.jsncd.mongodb.net/test

- Database Created Successfully.

- After successfully connection with Mongo DB, create database.
  - Click on Create Database button and then enter Database Name and Collection name as shown in the below image:
  - Note : When import collection into database its name must be admins and settings (Another collection names are not work properly)

- For inserting data into collection follow this step

#### Setup your node js Project (backend):

##### Step 1

For install packages (execute in Terminal) npm install

##### Step 2

Change the serverPath in util/serverpath.js and also change serverkey (Which is copied from Firebase)

Put the MongoDB Copied Connection String in index.js file

Put Your Email and Password in server/admin/admin.controller.js.

##### Step 3

Then run the command in terminal :- npm start

## Admin Panel Configuration

#### Setup your React.js Project(frontend)

##### Step 1

For install packages (execute in Terminal) npm install

##### Step 2

Change the serverPath in src/util/serverpath.js

##### Step 3

Then run the command in terminal :- npm start

##### Step 4

Sign in the Admin Panel and also Enter Key and package

- After Successfully setup of backend or frontend , Use this credentials for login
- Email : admin@admin.com
- Password : 123456

## FAQ

#### Which Node version?

it will work on v12.18.3

#### Which Database You are using?

We are using MongoDB database

#### Does it have Admin panel

Yes It has admin panel as well which is in HTML/CSS and connected with database via Node js API

#### Does it have Documentation

Yes it has Documentation about android , web api setup , admin panel setup , firebase push notification setup

## Contact Us