English Documentation | 中文文档
📖 Full Documentation: For comprehensive documentation including installation guides, API documentation, configuration options, and development guidelines, please visit DLP3D Web Backend Documentation
DLP3D Web Backend is a web backend service built with FastAPI and MongoDB, designed to provide RESTful APIs for 3D motion data management, user management, character configuration, and motion file access. The service includes comprehensive motion data handling capabilities with support for multiple data sources including filesystem, MinIO object storage, and MySQL/SQLite databases.
The system is specifically designed for DLP3D web application, providing efficient access to motion files, restpose data, mesh files, and metadata through a unified API interface.
- Multi-Source Data Access: Support for filesystem, MinIO object storage, MySQL, and SQLite data sources
- User Management: Complete user lifecycle management including creation, authentication, and deletion
- Character Configuration: Advanced character management with support for TTS, ASR, classification, conversation, reaction, and memory configurations
- Motion File API: High-performance motion data access with caching and version control
- RESTful API: Comprehensive REST API with OpenAPI/Swagger documentation
- MongoDB Integration: Automatic database bootstrap and user provisioning
- Caching System: Intelligent local caching with automatic maintenance and version checking
- Log Management: Real-time log access and download capabilities
- Health Monitoring: Built-in health check endpoints for service monitoring
The DLP3D Web Backend follows a modular, layered architecture.
Core Components:
- FastAPIServer: Main HTTP server with CORS support and error handling
- MotionFileApiV1: Motion data access API with caching and version control
- LocalCache: Intelligent caching system with automatic maintenance
- Data Readers: Modular readers for different data sources
- MongoDB Integration: Automatic database setup and user provisioning
To use DLP3d web backend service, you need to download the offline motion database and set up the required directory structure.
For download links, directory structure, and detailed setup instructions, please refer to:
📖 Data Preparation Documentation
This guide helps you run web backend service quickly using Docker. For production or a full backend stack, consider the complete Docker Compose approach.
For the best experience, we recommend using Docker Compose to start the complete DLP3D services, which includes the web backend service and the web frontend service along with all required dependencies (MongoDB, Audio2Face, Speech2Motion, etc.).
Please follow the Quick Start guide on ReadTheDocs to set up and run the entire infrastructure.
If you only need to run the web backend service independently (without the full DLP3D infrastructure), you can set it up using Docker or Docker Compose.
For detailed instructions on running the standalone backend service, including Docker setup, configuration options, and deployment guidelines, please refer to:
📖 Standalone Backend Service Documentation
The documentation covers:
- Docker container setup and configuration
- Environment variables and configuration options
- Database connection setup
- Service deployment best practices
This project is licensed under the MIT License. See the LICENSE file for details.
The MIT License is a permissive free software license that allows you to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software with minimal restrictions. The only requirement is that the original copyright notice and license text must be included in all copies or substantial portions of the software.