lynq-chat/README.md

LynqChatについて

セルフホスト型チャットアプリです。未完成です。

サーバー作成

本体

要件

• Node.js v24.14以上v25未満
• pnpm v10.17.0以上

# configのサンプルをコピー
# config/config.yamlをコメントに従って変更してください。
cp config/example.yaml config/config.yaml

# 依存関係のインストール
pnpm i

# ビルド
pnpm run build

# データベースのマイグレーション
pnpm -F backend migrator up

# 起動
pnpm -F backend start

PostgreSQL

サーバーがある場合はスキップして構いません。
空のデータベースが必要です。
現時点で、暗号化通信には対応していません。

Nix

Warning

ローカルのNix Storeにパスワードが平文で保存されます。

WSLの/mnt/*では、権限の制約によって動作しません。
/home/*などのディレクトリで使用してください。

# Configコピー
cp ./config/example.yaml ./config/config.yaml

# 起動
nix develop

# 停止:
pg_ctl -D postgres-data-nix stop
exit

開発

本体

要件

• Node.js v24.14以上v25未満
• pnpm v10.17.0以上

# configのサンプルをコピー
# config/config.yamlをコメントに従って変更してください。
cp config/example.yaml config/config.yaml

# 依存関係のインストール
pnpm i

# 起動
# (バックエンド/フロントエンドどちらもwatchします)
# http://localhost:5173 (デフォルトのフロントエンド)にアクセスしてください
# 開発環境のhttp://localhost:3300 (デフォルトのバックエンド)にはフロントエンド機能がありません
pnpm run dev

PostgreSQL

サーバー作成と同様