Reference

Technical reference documentation for V-Portal.

API Reference

REST API

• Authentication endpoints
• User management API
• Module API endpoints
• Data field API
• File upload API

WebSocket API

• Connection protocols
• Message formats
• Event streams

Configuration Reference

Environment Variables

• Backend configuration
• Database settings
• Security settings
• Module paths

Configuration Files

• docker-compose.yml
• Module configuration
• Nginx configuration

Database Schema

• Users and roles
• Pages and widgets
• Modules
• Data fields
• Logs

Architecture

System Architecture

• Component diagram
• Data flow
• Service communication

Module Architecture

• Module lifecycle
• Service registry
• Route handling

Standards & Conventions

Naming Conventions

• Data field naming
• API endpoints
• Module naming

Code Style

• C++ style guide
• JavaScript/TypeScript style
• Vue.js conventions

More detailed reference documentation coming soon!