diff --git a/README.md b/README.md index 350e829..edf9abf 100755 --- a/README.md +++ b/README.md @@ -1,51 +1,53 @@ -# LynqChat -チャットアプリです。 - -# サーバー作成 - -## 本体 -**要件** -- Node.js v24.14以上v25未満 -- pnpm v10.17.0以上 - -```bash -# configのサンプルをコピー -# config/config.yamlをコメントに従って変更してください。 -cp config/example.yaml config/config.yaml - -# 依存関係のインストール -pnpm i - -# ビルド -pnpm run build - -# データベースのマイグレーション -pnpm -F backend mikro migration:up - -# 起動 -pnpm -F backend start -``` - -## PostgreSQL -サーバーがある場合はスキップして構いません。 -空のデータベースが必要です。 -現時点で、暗号化通信には対応していません。 - -### Nix -> **WARNING** -> ローカルのNix Storeにパスワードが平文で保存されます。 - -WSLの`/mnt/*`では、権限の制約によって動作しません。 -`/home/*`などのディレクトリで使用してください。 - -```bash -# Configコピー -cp ./config/example.yaml ./config/config.yaml - -# 起動 -nix develop - -# 停止: -pg_ctl -D postgres-data-nix stop -exit -``` + + +# LynqChatについて +セルフホスト型チャットアプリです。未完成です。 + +# サーバー作成 + +## 本体 +**要件** +- Node.js v24.14以上v25未満 +- pnpm v10.17.0以上 + +```bash +# configのサンプルをコピー +# config/config.yamlをコメントに従って変更してください。 +cp config/example.yaml config/config.yaml + +# 依存関係のインストール +pnpm i + +# ビルド +pnpm run build + +# データベースのマイグレーション +pnpm -F backend mikro migration:up + +# 起動 +pnpm -F backend start +``` + +## PostgreSQL +サーバーがある場合はスキップして構いません。 +空のデータベースが必要です。 +現時点で、暗号化通信には対応していません。 + +### Nix +> **WARNING** +> ローカルのNix Storeにパスワードが平文で保存されます。 + +WSLの`/mnt/*`では、権限の制約によって動作しません。 +`/home/*`などのディレクトリで使用してください。 + +```bash +# Configコピー +cp ./config/example.yaml ./config/config.yaml + +# 起動 +nix develop + +# 停止: +pg_ctl -D postgres-data-nix stop +exit +```