Skip to content

くずは風掲示板を仕様・API・UI・配布 zip に分けた

くずは風(あやしいわーるど系)の掲示板を、OSS として公開できる形に組み直した。中心に置いたのは画面ではなく、画面とサーバの間の決まり(仕様)。決まりを守れば、サーバも画面も入れ替えられる。その最初の組み合わせとして、レンタルサーバに FTP で置くだけで動く版を作った。

システム全体の名前は kssw。6umi.net の API をもとにしている。どれも alpha 版で、repo はレビューの後に公開する。

min と full

API(掲示板のサーバ側)は 2 種類にする。

min full
実装 PHP 7.4+ / SQLite Python / PostgreSQL
状態 alpha 予定
目的 レンタルサーバに置くだけで動く 本格版。アカウント・翻訳など、min に無い機能を持つ
  • min は置ける場所の広さを優先した。レンタルサーバでいちばん広く使えるのが PHP。DB サーバも常駐するプロセスも要らない
  • full は TypeScript(Node)・Go も検討して Python にした
  • 2 つの実装が共有するのは、仕様と、仕様どおりに動くかを外から確かめるテストだけ

4 つの repo

  • ks-sw-spec:仕様。画面とサーバの間のやりとりの決まり
  • ks-sw-api:API の実装(今は min)
  • ks-kuzuha-ui:画面。ブラウザで動く静的ファイルだけでできている
  • ks-kuzuha-alternative:画面と min の API をまとめた zip。FTP で置くだけで動く

中心は API で、くずは風の画面はその上に載る画面の 1 つ。

仕様

  • API の実装や画面が増えても混乱しないよう、仕様を実装から切り離した
  • 中身は仕様の文章、API の定義(OpenAPI)、確かめるためのテスト。ライセンスはすべて MIT
  • サーバは自分の版と対応している機能を返す。画面は対応している機能だけを使う

管理

  • 主な使い手は AI エージェント。手元で動かすコマンド kssw-admin から、サーバの管理用 API を呼ぶ。結果は JSON で返る
  • ブラウザの管理画面(admin.php)は最低限:ログイン、最近の投稿、削除と復元
  • JavaScript なしで読める表示と RSS は、初版の後に入れる

設置

実行権限やパスの設定、初期パスワードは要らない。

  • 設定ページで、DB や設定ファイルが外から読めてしまわないかを確かめ、読めたら警告する
  • zip に入る設定ファイルは見本(config.example.json)だけ。更新するときは上書きで上げればよく、自分の設定は消えない
  • 設定ファイルの書き間違いは設定ページに出る
  • 管理のパスワードは admin.php の画面で作れる。Python は要らない

デモ

  • XREA の無料プランで動かしている。広告は無料プランの条件で入る

画面(ks-kuzuha-ui v0.5.0-alpha.1)

  • 板のタイトルは、板に付けたタグから決まる。デモは「@くずはAlternative」
  • フォントは設定で変えられる
  • 表示する言語は、URL の指定、閲覧者の選択、ブラウザの言語の順に決まる
  • 広報室(About ページ)に、動いている画面と API の版、それぞれのソースへのリンクを出す
  • 一覧の表示(標準・ツリー)はメニューで切り替える

配色

閲覧者は背景の色相とアクセント色を選べ、入力欄と選択範囲もテーマの色にできる。アクセント色と組み合わせると、きれいなデュオトーンになる。プロダクトとして愛着が湧き始めた。

暗い入力欄に、アクセント色の枠と選択範囲

  • 背景の色相 195、アクセントの色相 15・強さ 90%、入力欄・選択範囲はテーマの色

前回の宣言 · 2026-10-15-oss-cleanup

  • API の最小版の構成と、repo の分け方・名前を決める → 達成

次回

  • 公開用の 1 commit を作り直し、レビューして 4 repo を公開する

Created 2026-10-16 · Updated 2026-11-07