Once the local setup is completed, the next step is to run the application locally. This document provides the steps on how to run the digit-ui on a local machine.
Step 1: To run the application in the local environment, add the .env
file in the example
folder -
Step 2: Copy the following content and add it to the .env file. If the user is a citizen, configure the .env file as shown below:
Step 3: To run the application as an employee, update the value of the param to - REACT_APP_USER_TYPE=EMPLOYEE.
Step 4: To direct the front end to different environments, update the REACT_APP_GLOBAL
variable and add the GlobalConfig environment file corresponding to that environment.
To learn more about global config visit How to configure globalconfig.
Update both REACT_APP_PROXY_API
and REACT_APP_PROXY_ASSETS
to the environment URL.
Before initializing the frontend app locally, ensure that you are in the specified directory.
Step 1: To initialise the Yarn execute the below command -
Step 2: Once the yarn initialization is successful execute the below command -
Step 3: Running this command will start the application.
There are two types of login -
Employee: If you log in as an employee, the below screen is displayed.
HomePage Employee: Once the employee is logged in, users are redirected to the employee home page.
On the home page, users can see the cards mCollect, HRMS, NOC, Property Tax, etc These cards need to be added. Refer to the instructions on the link here to create an employee card.
HomePage Citizen: Once the citizens are logged in successfully, users are redirected to the citizen homepage.
Click on the link here to create a card for your module on the home page under "Citizen Services".
Refer to this section to learn about globalConfig file.
if you do not have a global config and AWS credentials are not present, then create a temporary local config under the path:
Include this between the head tags
Link to example.