Quick Start

Overview

This guide will walk you through cloning the repository, building the app, and logging in for the first time. By the end, you’ll have the app running on an Android device or emulator with a test user account.

Before starting, ensure you’ve completed the Installation guide with Android Studio and Firebase configured.

Step 1: Clone the Repository

Clone from GitHub

Open your terminal and run:

git clone https://github.com/gargmehul10/Sales-Management-App.git
cd Sales-Management-App

Verify Project Structure

Ensure the project structure looks like this:

Sales-Management-App/
├── app/
│   ├── build.gradle
│   ├── google-services.json  # Add your Firebase config here
│   └── src/
│       └── main/
│           ├── AndroidManifest.xml
│           ├── java/
│           │   └── project/avishkar/salesmanagement/
│           │       ├── Registration/
│           │       │   ├── MainActivity.java
│           │       │   ├── SignUpSalesManager.java
│           │       │   └── SignUpSalesperson.java
│           │       ├── ManagerMain.java
│           │       ├── SalespersonMain.java
│           │       ├── Chat/
│           │       ├── Graph/
│           │       ├── Leaderboard/
│           │       └── InventoryItem.java
│           └── res/
├── build.gradle
├── settings.gradle
└── gradle.properties

Add Firebase Configuration

Copy your google-services.json file into the app/ directory:

cp ~/Downloads/google-services.json app/

The app will not build without a valid google-services.json file. See Firebase Configuration if you haven’t set this up yet.

Step 2: Build the Project

Open in Android Studio

Launch Android Studio
Click Open an Existing Project
Navigate to the cloned directory and click OK
Wait for Gradle sync to complete

Sync Gradle Files

If Gradle doesn’t sync automatically:

Click File > Sync Project with Gradle Files
Wait for dependencies to download (first time may take 5-10 minutes)

You should see output like:

Gradle sync finished in 1m 23s

Build the Application

Build the app to verify everything works:

# From terminal
./gradlew assembleDebug

# Or in Android Studio
# Build > Make Project (Ctrl+F9)

Expected output:

> Task :app:compileDebugJavaWithJavac
> Task :app:mergeDebugResources
> Task :app:processDebugGoogleServices
> Task :app:packageDebug

BUILD SUCCESSFUL in 1m 45s
47 tasks executed

Step 3: Set Up an Emulator or Device

You can run the app on an Android emulator or physical device:

Android Emulator
Physical Device

Create a Virtual Device

In Android Studio, click Tools > AVD Manager
Click Create Virtual Device
Select a device (e.g., Pixel 3)
Choose a system image:
- Recommended: Oreo (API 26) or higher
- Minimum: Lollipop (API 22)
Click Finish

Launch Emulator

In AVD Manager, click the play button next to your device.Wait for the emulator to boot completely (30-60 seconds).

Enable Developer Options

On your Android device:

Go to Settings > About Phone
Tap Build Number 7 times
You’ll see “You are now a developer!”

Enable USB Debugging

Go to Settings > Developer Options
Enable USB Debugging
Connect device via USB
Accept the debugging prompt on your device

Verify Connection

adb devices

You should see:

List of devices attached
ABC123XYZ456    device

Step 4: Run the Application

Deploy to Device

# Click the green play button in toolbar
# Or press Shift+F10

The app will install and launch automatically.

Verify Launch Screen

You should see the login screen with:

Email and password input fields
Radio buttons for Manager/Salesperson selection
Login button
“Sign up as a Manager” link
“Sign up as a Salesperson” link

Step 5: Create Your First Account

Let’s create a test Sales Manager account:

Navigate to Manager Sign Up

On the login screen, tap “Sign up as a Manager”
You’ll be taken to the Manager registration form

Fill Registration Form

Enter the following details:

Name: Test Manager
Email: [email protected]
Password: test1234 (minimum 6 characters)
Phone: +1234567890
Company: Test Company

Password must be at least 6 characters as enforced by Firebase Authentication:

MainActivity.java:133

if (password.length() < 6) {
    inputPassword.setError(getString(R.string.minimum_password));
}

Complete Registration

Tap Sign Up
Wait for Firebase to create the account (2-3 seconds)
You’ll be automatically logged in and redirected to the Manager dashboard

Explore Manager Dashboard

You’re now in the Manager interface! You can:

My Team: View all salespersons (empty initially)
Inventory: Add and manage products
Chat: Access global chat room
Graphs: View profit analysis (requires inventory data)
Leaderboard: See top 10 salespersons
Profile: Update your account details

Step 6: Test Core Features

Let’s add some inventory to see the app in action:

Add Inventory Item

Tap Inventory from the navigation menu
Tap the + button (floating action button)
Enter item details:
- Name: Laptop
- Total Available: 100
- Sold: 25
- Profit per unit: 200
Tap Save

The inventory list will update with your new item:

InventoryItem.java:11

public InventoryItem(String itemName, int total_available, int sold, int profit) {
    this.itemName = itemName;
    this.total_available = total_available;
    this.sold = sold;
    this.profit = profit;
}

View in Firebase Console

Open your Firebase Console and navigate to Realtime Database:

{
  "Inventory": {
    "itemId_xyz": {
      "itemName": "Laptop",
      "total_available": 100,
      "sold": 25,
      "profit": 200
    }
  },
  "Manager": {
    "userId_abc": {
      "email": "[email protected]",
      "name": "Test Manager",
      "phone": "+1234567890"
    }
  }
}

All data syncs in real-time. Changes in Firebase Console appear instantly in the app, and vice versa.

Create a Salesperson Account

To test the full workflow:

Log out from Manager account
On login screen, tap “Sign up as a Salesperson”
Register with different credentials:
- Email: [email protected]
- Password: test1234
Explore the Salesperson dashboard

Salespersons can:

View inventory (read-only)
See their performance graphs
Check leaderboard ranking
Chat with the manager

Understanding User Roles

The app authenticates users and determines their role from Firebase:

if (RadioButtonSelect(radioGroup_type.getCheckedRadioButtonId()).equals("Manager")) {
    databaseRef = FirebaseDatabase.getInstance().getReference("Manager");
    databaseRef.addListenerForSingleValueEvent(new ValueEventListener() {
        @Override
        public void onDataChange(@NonNull DataSnapshot dataSnapshot) {
            for (DataSnapshot snapshot : dataSnapshot.getChildren()) {
                SalesManager sm1 = snapshot.getValue(SalesManager.class);
                if (sm1.getEmail().equals(email)) {
                    SessionManager sm = new SessionManager(getApplicationContext());
                    sm.createLoginSession(snapshot.getKey(), "Manager");
                    goto_Manager();
                    break;
                }
            }
        }
    });
}

Users must select the correct role (Manager or Salesperson) that matches their registration. If a manager selects “Salesperson” during login, authentication will fail with:“This Email is not registered as Salesperson!!”

Next Steps

Chat Feature

Learn how to use the global chat room and personal messaging

Analytics & Graphs

Understand performance tracking and profit analysis

Inventory Management

Deep dive into adding, updating, and tracking inventory

API Reference

Explore the Java classes and Firebase structure

Troubleshooting

App Crashes on Launch

Problem: App crashes immediately after launchCommon causes:

Missing or invalid google-services.json
Firebase services not enabled

Solution:

# Check logcat for errors
adb logcat | grep -i firebase

# Look for:
# "Default FirebaseApp is not initialized"
# "google-services.json is missing"

Verify Firebase configuration in Installation Guide.

Authentication Failed

Problem: “Authentication failed” error on loginSolution:

Verify Email/Password authentication is enabled in Firebase Console
Check that password is at least 6 characters
Ensure correct role is selected (Manager vs Salesperson)
Verify internet connection (app requires network access)

Data Not Appearing

Problem: Inventory or chat messages don’t show upSolution:

Check Firebase Realtime Database rules:

{
  "rules": {
    ".read": true,
    ".write": true
  }
}

Verify internet connectivity
Check Firebase Console to see if data is being written
Look for permission errors in logcat

Images Not Loading

Problem: Profile pictures or images don’t displaySolution:

Verify Firebase Storage is set up and accessible
Check storage rules allow read/write

Grant storage permissions:

AndroidManifest.xml:6

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

Accept permission prompts when the app requests them

Having issues? Check the GitHub Issues or create a new issue with your error logs.

Get Started

Core Features

User Guides

Technical

Overview

Step 1: Clone the Repository

Step 2: Build the Project

Step 3: Set Up an Emulator or Device

Step 4: Run the Application

Step 5: Create Your First Account

Step 6: Test Core Features

Understanding User Roles

Next Steps

Chat Feature

Analytics & Graphs

Inventory Management

API Reference

Troubleshooting

Build docs developers (and LLMs) love

Get Started

Core Features

User Guides

Technical

​Overview

​Step 1: Clone the Repository

​Step 2: Build the Project

​Step 3: Set Up an Emulator or Device

​Step 4: Run the Application

​Step 5: Create Your First Account

​Step 6: Test Core Features

​Understanding User Roles

​Next Steps

Chat Feature

Analytics & Graphs

Inventory Management

API Reference

​Troubleshooting

Build docs developers (and LLMs) love

Overview

Step 1: Clone the Repository

Step 2: Build the Project

Step 3: Set Up an Emulator or Device

Step 4: Run the Application

Step 5: Create Your First Account

Step 6: Test Core Features

Understanding User Roles

Next Steps

Troubleshooting