BaSyx AAS Web UI

A modern Vue.js web application for visualizing, managing, and interacting with Asset Administration Shells (AAS), Submodels, and Concept Descriptions in distributed BaSyx infrastructures.

✨ Key Features

• 🌐 Multi-Infrastructure Support - Connect to multiple distributed AAS infrastructures simultaneously
• 🔐 Secure Connections - Full OAuth2, Basic Auth, and Bearer Token authentication support
• ✏️ Editing Capabilities - Create, modify, and manage AAS, Submodels, and SubmodelElements
• 📊 Live Data Polling - Real-time updates for dynamic SubmodelElements
• 🔌 Plugin System - Extend functionality with custom Submodel visualization plugins
• 🧩 Modular Architecture - Develop custom application modules for specialized use cases
• ✅ AAS V3 Compliant - Full compliance with Asset Administration Shell V3 specification

📚 Documentation

Comprehensive documentation is available in the BaSyx Wiki.

• Supply Chain Security & Verification - Image signing, BuildKit provenance/SBOM attestations, and SBOM retrieval
• Security Policy - Vulnerability reporting process

🚀 Quick Start

For End Users (Deployment)

Pull and run the latest Docker image:

docker pull eclipsebasyx/aas-gui:latest
docker run -p 3000:3000 eclipsebasyx/aas-gui:latest

Access the UI at http://localhost:3000

📖 Detailed Guides:

• Getting Started with the Web UI - First steps and basic usage
• Docker Configuration - Deployment options and container setup
• Environment & Configuration - Environment variables and YAML-based infrastructure configuration
• Security Configuration - OAuth2, Basic Auth, and Bearer Token setup
• Working Examples - Ready-to-use Docker Compose examples with multi-infrastructure and time-series setups

For Developers (Extension & Contribution)

Clone the repository and start the development environment:

git clone https://github.com/eclipse-basyx/basyx-aas-web-ui.git
cd basyx-aas-web-ui
./bootstrap.sh

📖 Development Guides:

• Development Setup Guide - Prerequisites, environment setup, and local development
• Architecture Overview - Understanding the codebase structure and design patterns
• Plugin Development - Create custom Submodel visualization plugins (Demo Plugin)
• Custom Module Development - Build standalone application modules for the BaSyx UI
• Contribution Guidelines - Code standards, testing, and pull request process

📦 Examples

The examples/ directory contains ready-to-use configurations:

• MultiInfrastructure - Connect to multiple BaSyx environments with different authentication methods
• TimeSeriesData - Real-time time-series data visualization with InfluxDB
• PcfCalculation - Product Carbon Footprint calculation example
• CombinedExample - Combined example showcasing multiple features in one setup

🤝 Contributing

Contributions are welcome! To contribute:

1. Sign the Eclipse Contributor Agreement (ECA)
2. Fork the repository and create a feature branch
3. Make your changes following our code standards
4. Submit a pull request

All pull requests will be reviewed for compliance and functionality.

📄 License

This project is licensed under the MIT License. See LICENSE for details.