Developer & Integrator Guide

This section provides comprehensive documentation for developers building modules, integrations, and extensions for V-Portal.

For Module Developers

Learn how to create custom modules that extend V-Portal’s functionality:

• Module Development - Complete guide to creating modules
• Backend API - C++ SDK reference
• Frontend SDK - JavaScript/TypeScript SDK

For Application Developers

Build custom interfaces and applications:

• Widget Development - Create custom UI widgets
• Python API - Python integration and scripting

Architecture Overview

V-Portal uses a modular architecture:

• Backend (C++): Core server, module system, real-time data
• Frontend (Vue.js): User interface, widgets, page rendering
• Database (PostgreSQL): Persistent storage
• Modules: Pluggable extensions (.vmod files)

Development Tools

Backend Development

• CMake build system
• Crow web framework
• PostgreSQL C++ client
• WebSocket support

Frontend Development

• Vue.js 3
• TypeScript
• Vite build tool
• TailwindCSS

Getting Started

1. Set up your development environment
2. Clone the V-Portal repository
3. Build the core system
4. Create your first module

SDK Documentation

The V-Portal SDK is located in v-portal-sdk/ and provides:

• Module interfaces
• Service registry
• Data field system
• Route registration
• Widget base classes

Next Steps

• Create your first module
• Explore the Python API
• Build custom widgets