> 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/staff-portal/developer-install.md).

# Developer Install

### Setup

Follow these steps to set up Openg2p Staff Portal UI:

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

```
git clone git@github.com:OpenG2P/openg2p-staff-portal-ui.git
```

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

```
npm install
```

* **Configuration**: Configure the OpenG2P Staff Portal UI to connect to the APIs by setting the required environment variables.
* Create a `.env` file

```
IAM_URL="http://iam.openg2p.my"
KEYCLOAK_LOGOUT_URL="https://keycloak2.openg2p.org/realms/openg2p-staff/protocol/openid-connect/logout"
LOGIN_PROVIDER_ID="2"
COOKIE_DOMAIN=".openg2p.my"
REDIRECT_URL="http://staff-portal.openg2p.my"
```

**Nginx Configuration**: Configure Nginx to act as a reverse proxy for Openg2p Staff Portal UI

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

# Create a new configuration file for Openg2p Staff Portal UI
sudo nano /etc/nginx/sites-available/staff-portal.conf
```

* Below is a sample Nginx configuration (`/etc/nginx/sites-available/staff-portal.conf`).

```
server {
    listen 80;
    server_name staff-portal.openg2p.my;

    proxy_buffer_size 256k;
    proxy_buffers 8 512k;
    proxy_busy_buffers_size 512k;
    large_client_header_buffers 8 256k;

    location / {
        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;
    }
}
```

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

```
sudo ln -sf /etc/nginx/sites-available/staff-portal.conf /etc/nginx/sites-enabled/
```

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

```
sudo nano /etc/hosts
127.0.0.1 staff-portal.openg2p.my
```

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

```
sudo service nginx restart
```

* **Start Openg2p IAM Service**: Ensure that Openg2p IAM Service is up and running. Refer to the Openg2p IAM Service documentation.
* **Run Openg2p Staff 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://staff-portal.openg2p.my](http://farmer-registry.openg2p.my/)) to access the UI interface.

```
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/staff-portal/developer-install.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.