diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..68b2c50 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# whois.band + +バンドとアーティストの情報を管理するシンプルなサイト。ログイン不要、誰でも編集可能。 + +## 機能 + +- バンド情報の登録・編集(バンド名、活動拠点、リンク、メンバー) +- アーティスト情報の独立管理(名前、リンク) +- UUID と slug の2種類の URL でアクセス可能 +- 編集履歴管理(更新メッセージ + IP アドレス + JSON スナップショット) + +## URL 構造 + +| URL | 内容 | +|---|---| +| `/` | バンド一覧 | +| `/bands/of/:uuid` | バンド詳細 (UUID) | +| `/bands/named/:slug` | バンド詳細 (slug) → UUID URL へリダイレクト | +| `/bands/of/:uuid/edit` | バンド編集 | +| `/bands/of/:uuid/history` | バンド編集履歴 | +| `/bands/new` | バンド新規作成 | +| `/artists/of/:uuid` | アーティスト詳細 (UUID) | +| `/artists/named/:slug` | アーティスト詳細 (slug) → UUID URL へリダイレクト | +| `/artists/of/:uuid/edit` | アーティスト編集 | +| `/artists/of/:uuid/history` | アーティスト編集履歴 | +| `/artists/new` | アーティスト新規作成 | + +## 技術スタック + +- [React Router v7](https://reactrouter.com/) (SSR フレームワーク) +- [better-sqlite3](https://github.com/WiseLibs/better-sqlite3) (SQLite) +- [Tailwind CSS v4](https://tailwindcss.com/) +- TypeScript + +## 開発 + +```bash +npm install +npm run dev # 開発サーバー起動 (http://localhost:5173) +npm run build # プロダクションビルド +npm run typecheck # 型チェック +``` + +DB ファイル (`whois.db`) はプロジェクトルートに自動生成されます。 + +## デプロイ + +```bash +git push hetzner master +``` + +Hetzner サーバー上で `git push` フックにより自動ビルド・再起動。 |
