Build and Run Instructions

This guide explains how to build and run the Benefits Provider App UI.

Running Locally

1. Clone the Repository

   git clone https://github.com/PSMRI/ubi-provider-ui.git
   cd ubi-provider-ui

2. Install Dependencies

   yarn install

3. Set Up Environment

   • Configure environment variables as specified in Environment Variables

4. Start Development Server

   yarn dev

   The application will be available at http://localhost:5173

5. Build for Production

   yarn build

   The build output will be in the dist/ directory

6. Preview Production Build

   yarn preview

Build Output Structure

The production build (dist/ directory) contains:

• index.html - Entry point

• assets/ - Optimized JavaScript, CSS, and other assets

• Static files (images, fonts, etc.)

Common Issues and Solutions

1. Port Already in Use

   # Change port for development server
   VITE_PORT=3000 yarn dev

2. Node Version Mismatch

   # Use nvm to switch Node version
   nvm use 20

3. Build Errors

   • Clear node_modules: rm -rf node_modules

   • Clear yarn cache: yarn cache clean

   • Reinstall dependencies: yarn install

Deployment Options

You can host the UI on any hosting provider you prefer, such as S3 and CloudFront.

Here is an example pipeline showing deployment to S3 & CloudFront Invalidation using a CI/CD tool such as GitHub Actions.

• We are currently deploying the frontend on S3 (not using Docker). For detailed instructions, refer to the Frontend Deployment Documentation.