> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/health/v1.5/setup/installation/setup-mobile-app.md).

# Setup Mobile App

## Demo Video

[DIGIT Health Campaign Management Demo | DIGIT HCM](https://youtu.be/NB54Ve_smv0?si=4sjmLWk5YZgCJRdF)

## Overview

This guide provides step-by-step instructions to clone and run the DIGIT Health Campaign Management (HCM) App locally on your machine. The app is a Flutter application developed for health campaigns.

## Pre-requisites

Before you begin, ensure that you have the following installed on your PC:

* Flutter 3.16.5 version&#x20;
  * flutter setup for linux and android - [flutter document](https://docs.flutter.dev/get-started/install/linux/android)
  * flutter setup for windows and android - [flutter document](https://docs.flutter.dev/get-started/install/windows/mobile)
* Android device

## Steps

1. Open a terminal and run the following commands:
   1. git clone <https://github.com/egovernments/health-campaign-field-worker-app.git>
   2. git checkout to branch **installation-demo-setup**<br>
2. Open the project in your preferred IDE (Android Studio, Visual Studio Code). Make sure that your IDE is configured with the Flutter and Dart plugins.
3. Create a .env file inside the apps/health\_campaign\_field\_worker\_app  folder.
4. copy the below contents to you newly created .env file

```
BASE_URL={replace with base url}
MDMS_API_PATH='mdms-v2/v1/_search'
TENANT_ID="mz"`
ACTIONS_API_PATH="access/v1/actions/mdms/_get"
SYNC_DOWN_RETRY_COUNT="3"
RETRY_TIME_INTERVAL="5"
CONNECT_TIMEOUT="120000"
RECEIVE_TIMEOUT="120000"
SEND_TIMEOUT="120000"
CHECK_BANDWIDTH_API="/project/check/bandwidth"
ENV_NAME="DEMO"
```

## Steps to Generate APK&#x20;

* After successfully setting up the env file, navigate to **apps/health\_campaign\_field\_worker\_app** folder in the terminal,

* &#x20;Run the following command to generate the APK:&#x20;

  `flutter build apk --release --no-tree-shake-icons`

* &#x20;After successfully running the above command, the APK will be generated in the path

  **apps/health\_campaign\_field\_worker\_app/build\app\outputs\flutter-apk\app-release.apk**

* Install the generated APK on your preferred Android device.

```
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.digit.org/health/v1.5/setup/installation/setup-mobile-app.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
