Add free-tier deploy scaffolding (Community Cloud + Xserver redirect)

Author: Yuma-Ichikawa

.streamlit/config.toml

@@ -0,0 +1,23 @@
+# Streamlit runtime + theme defaults used by the public deployment.
+#
+# The theme palette matches ``app/_common.py::apply_theme`` so the first
+# paint (before custom CSS kicks in) is already on-brand.
+
+[theme]
+base = "dark"
+primaryColor = "#38bdf8"
+backgroundColor = "#05060a"
+secondaryBackgroundColor = "#0b1120"
+textColor = "#e2e8f0"
+font = "sans serif"
+
+[server]
+maxUploadSize = 20
+enableCORS = false
+enableXsrfProtection = true
+
+[browser]
+gatherUsageStats = false
+
+[client]
+showErrorDetails = false

README.md

@@ -110,6 +110,59 @@ The dashboard has four pages:
 - **Compare** — run a small hyper-parameter grid and inspect the result
   with parallel-coordinates and overlaid trajectories.
 
+## Deploy to the public web (free)
+
+The dashboard can be published for free via **Streamlit Community Cloud**
+(or Hugging Face Spaces) and bridged from any domain you already own
+(Xserver / お名前ドットコム / Cloudflare / …).
+
+### 1. Deploy to Streamlit Community Cloud
+
+The repository already ships the two files needed by Community Cloud:
+
+- [`requirements.txt`](requirements.txt) — CPU-only PyTorch pin plus the
+  minimal runtime. Installs this repo as the `qqa` package via the
+  trailing `.`.
+- [`.streamlit/config.toml`](.streamlit/config.toml) — on-brand dark
+  theme and telemetry off.
+
+Then:
+
+1. Go to <https://share.streamlit.io> and sign in with GitHub.
+2. **New app** → Repository `Yuma-Ichikawa/QQA4CO`, Branch `main`,
+   Main file path `app/streamlit_app.py`.
+3. Click **Deploy**. Your app will be served at
+   `https://<something>.streamlit.app` after a 3–5 min build.
+
+The custom-problem editor is **off by default** on public deployments
+(it evaluates arbitrary Python via `exec`). Re-enable it on a trusted
+machine with:
+
+```bash
+QQA_ALLOW_CUSTOM=1 uv run qqa gui
+```
+
+### 2. Point your own domain at the app
+
+If you own a domain on a shared rental host (e.g. Xserver), drop this
+snippet into the `public_html/` of the subdomain that you want to use
+(adjust the target URL):
+
+```apache
+RewriteEngine On
+RewriteRule ^(.*)$ https://qqa4co.streamlit.app/$1 [R=301,L]
+```
+
+A ready-to-copy template with both `301` and `iframe` variants lives at
+[`deploy/xserver-htaccess.example`](deploy/xserver-htaccess.example).
+
+### Other targets
+
+The repository is portable enough to drop onto any of the usual
+platforms: Hugging Face Spaces (Streamlit SDK), Fly.io / Render
+(Docker), Google Cloud Run. The same `requirements.txt` and
+`app/streamlit_app.py` serve as the entry points.
+
 ## Visualization
 
 ```python

app/streamlit_app.py

@@ -14,6 +14,7 @@
 
 from __future__ import annotations
 
+import os
 import sys
 from pathlib import Path
 
@@ -29,6 +30,12 @@
 
 import qqa  # noqa: E402
 
+# The custom-problem editor runs user-supplied Python via ``exec``. Disable
+# it on public deployments by setting ``QQA_ALLOW_CUSTOM=0`` (this is the
+# default on Streamlit Community Cloud / Hugging Face Spaces). Set it to
+# ``1`` to re-enable on a trusted machine.
+ALLOW_CUSTOM = os.getenv("QQA_ALLOW_CUSTOM", "0") == "1"
+
 st.set_page_config(
     page_title="QQA dashboard",
     page_icon="⚛️",
@@ -54,11 +61,18 @@
 with st.sidebar:
     st.header("1 · Problem definition")
 
-    use_custom = st.toggle(
-        "Use custom problem",
-        value=False,
-        help="Plug in your own loss_fn directly from this UI.",
-    )
+    if ALLOW_CUSTOM:
+        use_custom = st.toggle(
+            "Use custom problem",
+            value=False,
+            help="Plug in your own loss_fn directly from this UI.",
+        )
+    else:
+        use_custom = False
+        st.caption(
+            "Custom-loss editor is disabled on this deployment. "
+            "Set `QQA_ALLOW_CUSTOM=1` to enable it on a trusted machine."
+        )
 
     extra: dict = {}
     if use_custom:

deploy/xserver-htaccess.example

@@ -0,0 +1,50 @@
+# --------------------------------------------------------------------------
+# Xserver (shared rental) redirect for the QQA Streamlit dashboard
+# --------------------------------------------------------------------------
+#
+# Xserver の共用レンタルサーバーでは Streamlit プロセスを常駐できないため、
+# 計算部分は Streamlit Community Cloud / Hugging Face Spaces に置き、
+# Xserver のドメインはユーザーを外部ホスティングにリダイレクトする役割だけ
+# を担います。
+#
+# 使い方:
+#
+#   1) share.streamlit.io (または huggingface.co/spaces) に
+#      app/streamlit_app.py をデプロイする。
+#   2) 発行された URL を下の TARGET に差し替える。
+#   3) このファイルを `.htaccess` にリネームし、Xserver の対象サブドメイン
+#      の `public_html/` 直下に FTP またはファイルマネージャでアップロード。
+#
+# 301 リダイレクト方式 (アドレスバーに Streamlit 側の URL が表示される)
+# --------------------------------------------------------------------------
+
+RewriteEngine On
+# TARGET: replace with your deployed URL, for example:
+#   https://qqa4co.streamlit.app
+#   https://huggingface.co/spaces/<you>/qqa4co
+RewriteRule ^(.*)$ https://qqa4co.streamlit.app/$1 [R=301,L]
+
+
+# --------------------------------------------------------------------------
+# iframe 方式を使う場合 (アドレスバーに Xserver 側ドメインが残る)
+# --------------------------------------------------------------------------
+# 上記 RewriteRule をコメントアウトし、同じ public_html/ に以下の
+# index.html を置く:
+#
+#   <!doctype html>
+#   <html lang="ja">
+#   <head>
+#     <meta charset="utf-8">
+#     <title>QQA dashboard</title>
+#     <style>html,body,iframe{margin:0;height:100%;width:100%;border:0}</style>
+#   </head>
+#   <body>
+#     <iframe src="https://qqa4co.streamlit.app"
+#             allowfullscreen
+#             allow="clipboard-read; clipboard-write"></iframe>
+#   </body>
+#   </html>
+#
+# 注: Streamlit Community Cloud は X-Frame-Options: SAMEORIGIN を
+# 返さないので iframe 埋め込みは通常問題なく動作しますが、公式保証は
+# されていません。301 リダイレクトの方が確実です。

requirements.txt

@@ -0,0 +1,29 @@
+# Streamlit Community Cloud / lightweight deployment dependency list.
+#
+# Notes
+# -----
+# * We pin the CPU wheel of PyTorch to avoid pulling the ~900 MB CUDA build
+#   (which blows through the 1 GB Community Cloud image budget).
+# * The trailing `.` installs this repository itself as the ``qqa`` package
+#   so ``import qqa`` works inside the Streamlit app.
+#
+# Local development should still use ``uv sync --all-extras``; this file is
+# only consumed by pip-based deploy targets (Streamlit Community Cloud,
+# Hugging Face Spaces, Render, etc.).
+
+--extra-index-url https://download.pytorch.org/whl/cpu
+torch==2.4.1+cpu
+
+numpy>=1.24
+networkx>=3.1
+scipy>=1.11
+matplotlib>=3.8
+tqdm>=4.66
+
+# Interactive plots + GUI
+plotly>=5.17
+pandas>=2.0
+streamlit>=1.30
+
+# Install this repository (reads pyproject.toml)
+.

tests/test_gui_apptest.py

@@ -14,10 +14,14 @@
 
 from __future__ import annotations
 
+import os
 from pathlib import Path
 
 import pytest
 
+# The Home page hides the custom-problem toggle unless this env var is set.
+os.environ.setdefault("QQA_ALLOW_CUSTOM", "1")
+
 pytest.importorskip("streamlit", minversion="1.29.0")
 
 from streamlit.testing.v1 import AppTest  # noqa: E402