23 lines
1.4 KiB
Markdown
23 lines
1.4 KiB
Markdown
# TestArena Backend Documentation
|
|
|
|
Welcome to the official documentation for the TestArena Backend. This system is designed to automate the build and test execution process for ESP32 projects using ESP-IDF and QEMU.
|
|
|
|
## Table of Contents
|
|
|
|
1. **[Architecture & Design](architecture.md)**: Overview of the system components, technology stack, and design principles.
|
|
2. **[Usage Guide](usage.md)**: Instructions on how to deploy, configure, and use the system.
|
|
3. **[API Reference](api_reference.md)**: Detailed documentation of the available REST API endpoints.
|
|
4. **[Workflows & Flowcharts](flow_diagrams.md)**: Visual representations of the system's key processes.
|
|
|
|
## Project Overview
|
|
|
|
TestArena is a robust platform for managing and executing automated test scenarios. It provides a web-based dashboard for monitoring test queues, real-time logging of execution steps, and detailed HTML reports of test results.
|
|
|
|
### Key Features
|
|
|
|
* **Automated Build & Test**: Automatically clones repositories, builds firmware, and executes tests in a QEMU environment.
|
|
* **Real-time Monitoring**: Live dashboard with search, sorting, and queue management (abort/delete).
|
|
* **Comprehensive Logging**: Timestamped and leveled logs for every step of the process.
|
|
* **Scalable Architecture**: Decoupled API and Worker services for better performance and reliability.
|
|
* **Easy Deployment**: Automated deployment script for quick setup on Ubuntu servers.
|