Project Setup Guide

This guide provides instructions for setting up the Fineract Backoffice UI development environment.

Prerequisites

Clone the repository:

git clone https://github.com/apache/fineract-backoffice-ui.git
cd fineract-backoffice-ui

For convenience, the following scripts are provided for local development (Linux/macOS):

./run-local.sh: One-step setup. Installs dependencies, generates local SSL certificates (using OpenSSL), and starts the server in HTTPS mode.
./cleanup-local.sh: Safely stops background Angular processes and removes temporary build/SSL artifacts.

Secure Development (SSL): Since Fineract sandboxes often require HTTPS, run the following to set up local trusted certificates (requires mkcert):
```
./scripts/setup-ssl.sh
```
Run the application:
- Local Development:
```
npm start
```
- Mifos Sandbox:
```
npm run start:sandbox
```
  Access the UI at http://localhost:4200 (or https://localhost:4200 if using SSL).
Connecting to a Sandbox: Update src/environments/environment.ts with your sandbox URL:
```
fineractApiUrl: 'https://demo.mifos.io/fineract-provider/api/v1';
```
Run unit tests:
```
npm run test
```
Run end-to-end tests:
```
npm run test:e2e
```
Run linting:
```
npm run lint
```
Format code:
```
npm run format
```

Build and start container:
```
cd deploy
docker-compose up --build
```
Access the UI at http://localhost:8080.