> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/platform/portals-and-apps/beneficiary-portal/developer-zone/developer-setup/openg2p-beneficiary-portal-ui.md).

# Openg2p Beneficiary Portal UI

### Setup

Follow these steps to set up Openg2p Beneficiary Portal UI:

* **Clone the Repository**: Clone the Openg2p Beneficiary Portal UI repository from the source:

```sh
git clone https://github.com/OpenG2P/openg2p-beneficiary-portal-ui.git
```

* **Install Dependencies**: Navigate into the cloned Openg2p Beneficiary Portal UI directory and install dependencies using npm:

```sh
npm install
```

* **Configuration**: Configure Openg2p Beneficiary Portal UI to connect with the Openg2p Portal Server. This typically involves setting environment variables

```shellscript
NEXT_PUBLIC_BASE_PATH="/selfservice"
NEXT_PUBLIC_BASE_API_PATH="/v1/selfservice"
NEXT_PUBLIC_LANGUAGES_SUPPORTED="en fr tl"
```

* **Nginx Configuration**: Configure Nginx to act as a reverse proxy for Openg2p Portal Server.

```sh
# Install Nginx if not already installed
sudo apt-get update
sudo apt-get install nginx -y

# Create a new configuration file for Openg2p Portal server
sudo nano /etc/nginx/sites-available/selfservice.conf
```

* Below is a sample Nginx configuration (`/etc/nginx/sites-available/selfservice.conf`).
* This configuration directs requests to `/v1/selfservice` to Openg2p-Portar-Server running on port 8001,

```
server {
    listen 80;
    server_name selfservice17.openg2p.my;
    location = / {
        return 301 /selfservice;
    }
    location /selfservice {
        proxy_pass                      http://localhost:3000;
        proxy_http_version              1.1;
        proxy_set_header                Upgrade $http_upgrade;
        proxy_set_header                Connection "upgrade";
        proxy_set_header                Host $host;
        proxy_set_header                Referer $http_referer;
        proxy_set_header                X-Real-IP $remote_addr;
        proxy_set_header                X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header                X-Forwarded-Proto $scheme;
        proxy_pass_request_headers      on;
    }
    location /v1/selfservice/ {
        proxy_pass                      http://localhost:8001/;
        proxy_http_version              1.1;
        proxy_set_header                Upgrade $http_upgrade;
        proxy_set_header                Connection "upgrade";
        proxy_set_header                Host $host;
        proxy_set_header                Referer $http_referer;
        proxy_set_header                X-Real-IP $remote_addr;
        proxy_set_header                X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header                X-Forwarded-Proto $scheme;
        proxy_pass_request_headers      on;
    }
}
```

* **Enable Configuration**: Enable the Nginx configuration by creating a symbolic link to `sites-enabled`

```sh
ln -s /etc/nginx/sites-available/selfservice.conf /etc/nginx/sites-enabled/
```

* **Adding domain to Hosts**: Add the domain to the hosts for the system to recognize the domain.

```sh
sudo nano /etc/hosts
#127.0.0.1       selfservice17.openg2p.my
#add the above line
```

* **Restart Nginx**: Restart the Nginx service to apply the changes:

```sh
sudo service nginx restart
```

* **Start Openg2p Portal Server**: Ensure that Beneficiary Portal Server is up and running. Refer to the Openg2p Portal Server documentation.
* **Run Openg2p Beneficiary Portal UI**: This command starts the development server. Open a web browser and navigate to the specified URL ([http://localhost:3000](http://localhost:3000/)) or a specific domain as per nginx server (<http://selfservice17.openg2p.my/selfservice>) to access the UI interface.

```sh
npm run dev
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.openg2p.org/platform/portals-and-apps/beneficiary-portal/developer-zone/developer-setup/openg2p-beneficiary-portal-ui.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.