OpenGINXplore

OpenGINXplore is a frontend web application for exploring structured government information in a clear, discoverable, and visual way.

It provides a unified interface for navigating entities, their relationships, hierarchies, and historical changes over time, allowing users to understand how institutions, roles, and structures evolve.

OpenGINXplore consumes the GI-Service (Backend-for-Frontend), which exposes OpenGIN-based structured data through a set of tailored APIs optimized for frontend exploration and visualization.

This application serves as a sample government exploration app, using data related to the Government of Sri Lanka as a reference implementation. While the current dataset used is Sri Lanka–specific, the application is designed to be adaptable to any domain that follows the OpenGIN data model.

Data Flow

flowchart LR
    FE["Frontend<br/>(OpenGINXplore)"]
    API["GI-Service<br/>(API Adapter / BFF)"]
    CORE["OpenGIN<br/>(Core Data Platform)"]

    FE <-->| REST | API
    API <-->| Query APIs | CORE

    %% Base styles
    classDef blue fill:#E3F2FD,stroke:#1565C0,stroke-width:1px,color:#0D47A1
    classDef green fill:#C8E6C9,stroke:#1B5E20,stroke-width:3px,color:#0B3D0B

    class API blue
    class CORE blue
    class FE green

Loading

Features

Feature	Description
Government Structure Visualization	Enables exploration of the hierarchical structure of the Sri Lankan government, showing relationships between ministries, departments, and affiliated entities in a clear and structured manner.
Graph-Based Exploration	Provides an interactive, graph-based interface to visually navigate government entities and understand complex organizational relationships intuitively.
Data Catalog Discovery	Allows users to browse and discover datasets published by the government, ministries, and departments through a centralized data catalog.
Data Visualization & Yearly Comparison	Supports visualization of published datasets and comparison across multiple years to identify trends and changes over time.
Historical Government Information	Presents historical records of ministries, departments, and key personnel, enabling users to track structural and leadership changes over time.

Getting Started

Installation & Setup

Prerequisite

• Node V20+
• Git

1. Clone the Repository

git clone https://github.com/LDFLK/openginxplore.git
cd openginxplore

2. Install Dependencies

npm install

3. Configuration

Create a config.js file in the public directory

window.configs = {
  apiUrl: "<OPENGIN_READ_URL>",
  apiUrlData: "<GI_SERVICE_BASE_URL>",
};

4. Run the Application (development)

Using Terminal

npm run dev

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

5. Config local proxy (React vite apps)

If you encounter a CORS error, configure a local proxy in the vite.config.js file.

Update server block in the vite.config.js file.

import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import path from 'path'

export default defineConfig({
    base: '/', 
    plugins: [react()],
    resolve: {
        alias: {
            '@': path.resolve(__dirname, './src'),
        },
    },
    server: {
        proxy: {
            '/v1': {
               target: 'http://localhost:8081',
               changeOrigin: true,
               secure: false,
               rewrite: (path) => path.replace(/^\/v1/, '/v1'),
            },
        },
    },
})

Configuration

Configuration Variables

Update the config.js file in the public directory

Variable	Required	Description	Default
apiUrl	Yes	Query (Read) OpenGIN service URL	http://localhost:8081
apiUrlData	Yes	GI-Service URL	http://localhost:8000
feedbackFormUrl	No	Feedback Form URL	empty
version	No	Application Version	rc-1.0.0
dataSources	No	Data Sources	https://data.gov.lk/

Contributing

Please see our Contributing Guidelines.

Code of Conduct

Please see our Code of Conduct.

Security

Please see our Security Policy.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

References

• OpenGIN
• GI-Service