Project Overview

Offline Kiosk - Complete Documentation

Comprehensive documentation for the Offline Kiosk system

Generated: 2026-05-06T07:42:12.006Z

Project Overview

A React-based offline-first kiosk system for laundry machines with Node.js backend, MQTT integration, payment processing, and WiFi management.

Architecture

System Components

1. Frontend (React) - User interface kiosk application
2. Backend (Node.js) - API server and business logic
3. Database (PostgreSQL) - Data persistence
4. MQTT Broker (EMQX) - Real-time messaging
5. Deployment Service - Automated deployment management
6. WiFi Manager - Network connectivity management

Documentation Modules

• React Frontend Application
• Node.js Backend Server
• Automated Deployment Service
• WiFi Management Scripts
• Infrastructure and Docker Configuration

Quick Start

Prerequisites

• Docker and Docker Compose
• Node.js 20+
• Git

Installation

# Clone the repository
git clone <repository-url>
cd offline-kiosk

# Start all services
docker-compose up -d

Environment Variables

Backend Server

• NODE_ENV - Environment (production/development)
• DB_HOST - PostgreSQL host
• DB_PORT - PostgreSQL port
• DB_NAME - Database name
• DB_USERNAME - Database username
• DB_PASSWORD - Database password
• MQTT_BROKER_URL - MQTT broker URL
• MQTT_USERNAME - MQTT username
• MQTT_PASSWORD - MQTT password

Contributing

This documentation is automatically generated from source code comments. To update the documentation:

1. Update comments in the source code
2. Push changes to the repository
3. CI/CD pipeline will automatically update BookStack