Skip to content

eclipse-autowrx/autowrx

Repository files navigation

AutoWRX

AutoWRX is a cloud-based, rapid prototyping environment for software-defined vehicle (SDV) applications. It provides a platform for building and testing new SDV-enabled features against real-world vehicle APIs, with seamless migration to automotive runtimes like Eclipse Velocitas.

Overview

AutoWRX is part of the digital.auto ecosystem and serves as a playground for virtual exploration of connected vehicle applications. The platform enables developers to:

  • Browse and explore vehicle API catalogs
  • Build and test connected vehicle app prototypes in the browser using Python, C++, or Rust
  • Visualize real-time signal data from vehicle runtimes
  • Connect to KUKSA Data Broker and other automotive services
  • Showcase customer journeys and feature demos
  • Migrate prototypes to production automotive runtimes

Architecture

AutoWRX follows a Core vs. Plugin philosophy:

  • The Core: Provides essential, universal functionality (authentication, basic page rendering) as a stable foundation
  • Plugins: Most features are designed as optional plugins, keeping the base platform lean and allowing for flexibility and customization

The platform uses a dynamic component architecture that enables plugin-provided UI components to be seamlessly rendered within the core application, making the entire UI configuration-driven.

Project Structure

This is a monorepo containing:

  • backend/ - Node.js/Express API server with MongoDB

    • RESTful API for authentication, models, prototypes, APIs, and more
    • Plugin management and dynamic component support
    • See backend/README.md for details
  • frontend/ - React/Vite application

    • Dashboard interface for vehicle signal visualization
    • Prototype execution and debugging
    • Plugin-based UI architecture
    • See frontend/README.md for details
  • docs/ - Comprehensive documentation

    • Development guides
    • Plugin development documentation
    • Architecture and design principles
    • Deployment guides
  • instance-setup/ - Production deployment configuration

    • Docker Compose setup for production
    • Environment configuration examples

Getting Started

For Developers

If you want to set up AutoWRX for local development, see the Development Guide for step-by-step instructions.

Quick overview:

  1. Set up MongoDB (Docker or remote)
  2. Configure backend and frontend environment variables
  3. Install dependencies and start both services
  4. Access the application at http://localhost:3200

For Deployment

If you want to deploy AutoWRX to production, see the Instance Setup Guide for deployment instructions.

Features

  • Vehicle API Catalogue: Browse, explore, and enhance connected vehicle interfaces
  • Prototyping: Build and test SDV applications using Python and Vehicle API
  • Real-time Visualization: Monitor vehicle signal data in real-time
  • Plugin System: Extensible architecture with dynamic plugin loading
  • User Feedback: Collect and evaluate feedback to prioritize development
  • Containerized Execution: Run prototype code in isolated environments

Documentation

Technology Stack

  • Backend: Node.js, Express, MongoDB, Mongoose
  • Frontend: React, TypeScript, Vite, Tailwind CSS
  • Database: MongoDB
  • Containerization: Docker, Docker Compose

Contributing

This project is part of the open-source digital.auto initiative. Contributions are welcome!

Please review the documentation in the docs/ directory and follow the project's coding standards and guidelines.

License

License: MIT

Copyright (c) 2025 Eclipse Foundation.

This program and the accompanying materials are made available under the terms of the MIT License which is available at https://opensource.org/licenses/MIT.

SPDX-License-Identifier: MIT

Links


Note: For development setup, see development-guide.md. For production deployment, see instance-setup/.

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors 13