Home

Effective Office Wiki

Welcome to the Effective Office documentation wiki. This wiki contains comprehensive information about the Effective Office system, a platform designed to automate various office processes with a primary focus on meeting room booking and workspace management.

Quick Navigation

System Overview

• Overview - High-level introduction to the system architecture, core components, and fundamental concepts
• System Architecture - Comprehensive overview of the system architecture, design patterns, and component interactions

Components

• Backend System - Details about the Spring Boot backend application, REST APIs, and core business logic
  • Booking Management - Information about room and workspace reservation functionality
  • Workspace Management - Information about workspace organization and tracking
  • Database & Configuration - Information about database schema and application configuration
  • Notifications & Real-time Updates - Information about push notifications and real-time synchronization
• Tablet Client Application - Information about the Compose Multiplatform tablet client application
  • Navigation and App Structure - Information about navigation patterns, component architecture, and application structure
  • Room Display and Slot Managment - Information about room display and time slot management system
  • Booking Features - Information about booking-related features including booking editor, fast booking, and room release
  • UI Components - Information about reusable UI components, date/time pickers, modal dialogs, and design system

Features and Implementation

• Core Features - Overview of the main features including room booking, real-time status display, and fast booking
  • Room Booking Workflow - Information about the end-to-end process for booking meeting rooms
  • Real-time Availability System - Information about live updates of room availability and booking changes
  • Fast Booking Feature - Information about streamlined interface for immediate room reservations
• Data & Domain Architecture - Details about the domain layer architecture, use case patterns, and data flow
  • Domain Use Cases - Information about business logic implementation and use case patterns in the tablet client
  • Data Layer & Repository - Information about data access layer architecture, repository pattern implementations, and data coordination strategies
• Deployment & Operations - Information about deployment strategies, operational procedures, and production environment setup
  • Docker Deployment - Details about containerized deployment architecture using Docker and Docker Compose
  • Configuration Management - Information about application configuration patterns and environment variable management
  • Google Workspace & Calendar Integration - Comprehensive guide for setting up Google Workspace and Google Calendar with the system

Development

• Development Guide - Information about project setup, architectural patterns, development workflows, and contribution guidelines
• Getting Started with Effective Office - Comprehensive guide for setting up and running the Effective Office project for local development
• Project Structure - Comprehensive overview of the codebase organization, module structure, and dependency management
• Build System & Tooling - Information about Gradle configuration, multiplatform setup, and development tooling

Documentation Structure

The documentation is organized into several main sections:

1. System Overview - General information about the system's purpose, architecture, and components
2. Backend System - Details about the server-side implementation, APIs, and services
3. Tablet Client Application - Information about the client-side implementation, UI components, and user interactions
4. Core Features - Detailed descriptions of the main system features and their implementations
5. Data & Domain Architecture - In-depth information about the domain models, business logic, and data flow patterns
6. Deployment & Operations - Details about deployment strategies, operational procedures, and production environment setup

Each section contains detailed information about specific aspects of the system, including diagrams, code examples, and implementation details.