Project Setup Guide

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

Prerequisites

The Angular CLI is a project dependency. Use the repository scripts instead of installing a global CLI, which can be a different major version.

Clone the repository:

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

Secure Development (SSL): The development server is configured for HTTPS. Generate trusted local certificates once (requires mkcert):
```
./scripts/setup-ssl.sh
```
Run the application:
```
npm start
```
Access the UI at https://localhost:4200.
Connect to Fineract:

Configuration is loaded from public/config.json at runtime; do not edit an environment file to configure a deployment.

For a local Fineract instance listening on https://127.0.0.1:8443, proxy.conf.json forwards both /api/v1, the default endpoint, and /fineract-provider/api/v1, the Local Proxy Server option on the sign-in page, to it. Either works with npm start, and neither makes a cross-origin request.

For a deployed or remote instance, set fineractApiUrl in config.json. An absolute URL must also appear in allowedApiOrigins, because the selected endpoint receives the user's credentials. The same-origin /api/v1 path used by the Docker deployment is the preferred production setup; see README.md.
Run unit tests:
```
npm test -- --watch=false
```
Run end-to-end tests:
```
npx playwright install chromium # first run only
npm run test:e2e -- --project=mocked
```
The mocked project needs no Fineract instance. See DOCS/E2E_TESTING.md for the Docker-backed project and focused runs.
Run linting:
```
npm run lint
```
Format code:
```
npm run format
```

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