🎉 V-Portal 0.6.2 is released! Read more
Skip to Content
Introduction

V-Portal Documentation

Welcome to the V-Portal documentation!

V‑Portal is a modular web application framework for building industrial control, monitoring, and visualization interfaces. It provides a unified platform where backend services, real‑time data, and frontend user interfaces come together to support scalable, extensible industrial applications. V‑Portal is designed to grow with your system. Core functionality is provided by the platform, while additional capabilities are added through pluggable modules such as KPIs, robot integrations, and edge control.

At a high level, V‑Portal follows a modular, service‑oriented architecture:

The platform cleanly separates core platform responsibilities from domain‑specific functionality, enabling independent development and deployment of modules.

Why V‑Portal?

V‑Portal simplifies how industrial software is built, extended, and operated. Instead of creating isolated applications for each use case, V‑Portal provides a single, modular platform where control, monitoring, and visualization come together. Core platform services handle the fundamentals - security, communication, and integration - while modules add domain‑specific functionality as your system evolves.

Built for real‑time environments and complex integrations, V‑Portal enables teams to move faster, scale safely, and adapt without re‑architecting. Whether you’re connecting robots, visualising KPIs, or deploying edge logic, V‑Portal gives you a flexible foundation designed for industrial reality.

Core Components

Backend

The V‑Portal backend acts as the central integration layer for the platform. It provides:

  • RESTful API endpoints for platform and module functionality
  • WebSocket support for real‑time updates
  • A module system for extending backend capabilities
  • Authentication and user management
  • Secure access to system and device data

The backend is responsible for enforcing platform rules while allowing modules to plug in their own logic and APIs.

Frontend

The V‑Portal frontend is a web‑based user interface framework built to consume backend APIs and modules. It provides:

  • Reactive UI components for dashboards and control views
  • A widget system for composing screens
  • Module‑driven UI integration
  • Role‑based access to features and views

Frontend modules can contribute UI elements that seamlessly integrate into the overall application.

Module System

Modules are the primary way functionality is extended in V‑Portal. A module can include:

  • Backend APIs and business logic
  • Frontend widgets or views
  • Integration with external systems or hardware

Modules are independently developed and deployed, allowing teams to add or update features without changing the core platform.

Key Concepts

Modularity

V‑Portal is built around the idea that core platform functionality should remain stable, while domain‑specific features evolve independently through modules.

Real‑Time Communication

The platform supports real‑time data flows using WebSockets, making it suitable for live monitoring, control panels, and status dashboards.

Integration‑First Design

V‑Portal is designed to integrate with:

  • Industrial devices (robots, PLCs, edge systems)
  • xternal services and APIs
  • Custom in‑house systems

This makes it adaptable to a wide range of industrial environments.

Security and Access Control

Authentication and user management are built into the platform, enabling:

Controlled access to features and data Separation of concerns between users, roles, and modules

Getting Started

To begin working with V‑Portal, explore:

Last updated on
Overview