Overview

Once the development environment setup is completed, we have to run the application locally. This document provides steps on how to run the works_shg_app on a local device.

Steps

1. Clone the repo https://github.com/egovernments/DIGIT-Works

git clone https://github.com/egovernments/DIGIT-Works.git

1. To run the application in the local environment, add the .env file in the root folder of the project (frontend/works_shg_app)-

Sample .env config:

BASE_URL='https://works-dev.digit.org/'

MDMS_API_PATH='egov-mds-service/v1/_search'

GLOBAL_ASSETS='https://works-dev.digit.org/works-dev-asset/worksGlobalConfig.json'

ENV_NAME="DEV"

1. Run the below commands in your terminal from the root of the project (frontend/works_shg_app)

flutter clean: To clean the build cache.

flutter pub get: To install the dependencies packages

1. Enable the desired device or browser to run the application using the command - flutter run: To start the application

1. Access the Flutter development tools for debugging purposes from the link in the terminal.

Steps

1. Install Flutter on your device

   • Install Flutter

   • Setup an Editor

2. After installation of Flutter, to check the installed version, use the command flutter --version

1. Run the Flutter Doctor command once the Flutter is installed. The Flutter Doctor performs the following tasks:

   • Downloads missing files required by the development environment.

   • Ensures we’ve installed the following:

   • Android SDK

   • Apple Xcode (on Mac)

   • Ensures that we’ve agreed to all software development licenses.

   • Checks the Android Studio IDE setup and recommends any changes required to get it working with Flutter.

   • Checks for connected devices.

   • Verifies that Flutter can recognize any connected hardware devices.

   • Recommends any changes required to get them connected and working.

   • Outputs a diagnosis, listing out issues found and recommendations.

2. If you want to run in local Chrome, make sure web security is disabled to avoid CORS errors.

Find below the steps to disable the web security of Chrome

For Android Studio IDE:

Setting up Emulator in Android Studio

For Visual Studio Code IDE:

Setting up Emulator in VS Code