Carambus API Documentation¶
Welcome to the Carambus API documentation. This directory contains comprehensive documentation for the Carambus billiards management system.
📚 Documentation Index¶
Core Documentation¶
- About - Developer information and project overview
System Setup & Configuration¶
- Scoreboard Autostart Setup - Complete guide for setting up scoreboard autostart functionality
- Mode Switcher - Switch between LOCAL and API modes in single folder
- Table Reservation and Heating Control - Automated table reservation and heating control
Database & Data Management¶
- Database Design - Complete database schema and design documentation
- Database Syncing - Database synchronization procedures
Tournament Management¶
- Tournament Management - Tournament administration and management
- Tournament Duplicate Handling - Handling duplicate tournament entries
- Game Plan Reconstruction - Reconstructing game plans and schedules
League Management¶
- League Match Days - League match day management
System Administration¶
- Admin Roles - Administrative roles and permissions
- Data Management - Data management procedures
- Privacy - Privacy and data protection information
Technical Documentation¶
- ER Diagram - Entity-Relationship diagram
- Paper Trail Optimization - Optimizing paper trail functionality
- Filter Popup Usage - How to use filter popups in the interface
Terms & Legal¶
- Terms - General terms
Specialized Documentation¶
- Region Tagging Cleanup Summary - Summary of region tagging cleanup operations
🚀 Quick Start¶
For new users, we recommend starting with: 1. About - Understand the project 2. Scoreboard Autostart Setup - Set up the scoreboard system 3. Table Reservation and Heating Control - Learn about automated table management
🔧 System Requirements¶
- Ruby on Rails application
- PostgreSQL database
- WebSocket support for real-time features
- Google Calendar integration for table reservations
📞 Support¶
For technical support or questions about the documentation, please contact: - Email: gernot.ullrich@gmx.de - Project: Billardclub Wedel 61 e.V.
Last updated: January 27, 2025