serotonie/ovms-admin_frontend repository overview

⁠OVMS Admin

OVMS Admin is a full-stack project for managing OVMS vehicle telemetry and related services.

⁠Project structure

• Laravel app: laravel⁠
• Python trips recorder: python/trips-recorder⁠
• Mosquitto configuration: mosquitto⁠
• GitHub workflows: .github/workflows⁠

⁠Components

⁠Laravel

The Laravel application exposes the web interface and backend services.

⁠Python trips recorder

The Python service collects MQTT telemetry data and stores trip information.

⁠Mosquitto

The Mosquitto broker is configured for MQTT messaging between the services.

⁠Local development

⁠Prerequisites

• Docker and Docker Compose
• Python 3.12+
• PHP 8.4+
• Composer

⁠Run the stack

docker compose up -d

⁠Run Python tests

cd python/trips-recorder/src
pytest -q tests

⁠Run Laravel tests

cd laravel
php artisan test

⁠Run tests with a dedicated Redis container

docker compose -f docker-compose.yml -f docker-compose.test.yml up -d redis-test
export REDIS_HOST=127.0.0.1
export REDIS_PORT=6380
cd python/trips-recorder/src && pytest -q tests
cd ../../laravel && php artisan test

⁠CI

The repository uses GitHub Actions workflows organized by purpose:

• PR validation under .github/workflows/pr⁠
• Merge builds under .github/workflows/merge⁠
• Keep-up-to-date automation under .github/workflows/keep-up-to-date⁠