kmewithsui

Production-ready PHP web application for the KME with SUI chemistry bingo experience.

Requirements

• PHP 8.0 or newer
• MySQL or MariaDB
• A web server such as Apache or Nginx

Configuration

Create a local environment file from the example and set the database values:

cp .env.example .env

Required environment variables:

• APP_PORT
• APP_IMAGE_TAG
• APP_ENV
• DB_HOST
• DB_PORT
• DB_USERNAME
• DB_PASSWORD
• DB_DATABASE
• MYSQL_ROOT_PASSWORD
• APP_TIMEZONE
• APP_DEMO_MODE
• APP_LOGGING_ENABLED
• APP_LOG_HASH_SALT
• APP_LOG_RAW_IP
• APP_TRUST_PROXY
• COPYRIGHT_PAWAPON_URL
• COPYRIGHT_RATCHAPOL_URL

Never commit real credentials, database dumps, logs, or local environment files.

Deployment

1. Configure the production web server document root to this project directory.
2. Set the required environment variables in the hosting control panel or server configuration.
3. Import the production database through the approved database deployment process.
4. Verify that index.php can connect to the configured database.

Security

• Database credentials are read from environment variables.
• Local secrets are excluded from Git through .gitignore.
• Runtime connection errors are not exposed with raw database details.

Local Preview

Set APP_DEMO_MODE=true in .env to preview the interface with bundled image assets when a local database is not available. Keep this disabled in production.

Docker

The repository includes a production-oriented Docker setup for the PHP web application and MariaDB database.

1. Create .env from .env.example and set strong unique passwords.
2. Start the stack:

docker compose up -d --build

3. Open http://127.0.0.1:${APP_PORT}. The default local port is 8080.

The MariaDB container initializes the elements table from docker/mysql/init/001-schema.sql on the first run. Database data is stored in the named Docker volume kmewithsui_mysql_data. The migrate service runs database migrations before the web container starts.

Published release images are available from GitHub Container Registry:

docker pull ghcr.io/parkpawapon/kmewithsui:v1.0.0

Migrations

Run database migrations before deploying application code that depends on new database objects:

php scripts/migrate.php

Docker Compose runs the same command automatically through the migrate service.

Action Analytics Logs

The application records gameplay and navigation actions in the action_logs table for future analytics. Logged events include page views, card modal opens, random card selections, card reveals, game resets, keyboard random actions, and game completion.

Raw IP storage is disabled by default. The application stores ip_hash using APP_LOG_HASH_SALT; set APP_LOG_RAW_IP=true only when there is a documented production need and an approved retention policy.

Repository Governance

• Pull requests into main require at least one approving review.
• CODEOWNERS assigns repository ownership to @ParkPawapon.
• Commit messages and pull request titles follow Conventional Commits.
• CI validates PHP syntax and repository safety checks.
• CD creates a production package artifact from main.

Discord Notifications

GitHub Actions sends Discord channel notifications for branch creation, pushed commits, opened pull requests, reopened pull requests, and merged pull requests.

Configure the repository secret DISCORD_WEBHOOK_URL with the production Discord webhook URL. Do not commit webhook URLs or tokens to the repository.