update readme

vuejs-jp · Oct 9, 2024 · 9040ac1 · 9040ac1
1 parent fdffc4f
commit 9040ac1
Show file tree

Hide file tree

Showing 6 changed files with 197 additions and 2 deletions.
diff --git a/apps/web-docs/.vitepress/config.mts b/apps/web-docs/.vitepress/config.mts
@@ -10,7 +10,25 @@ export default defineConfig({
       { text: 'Top', link: '/' },
       { text: 'CSS', link: '/css/getting-started' },
       { text: 'Peatix', link: '/peatix/csv-usage' },
-      { text: 'Supabase', link: '/supabase/getting-started' },
+      {
+        text: 'Supabase',
+        items: [
+          {
+            text: 'Getting Started',
+            link: '/supabase/getting-started',
+          },
+          {
+            text: 'Database',
+            items: [
+              { text: 'Speaker, Paneler', link: '/supabase/db/speaker' },
+              { text: 'Sponsor', link: '/supabase/db/sponsor' },
+              { text: 'Job for jobboard', link: '/supabase/db/job' },
+              { text: 'Attendee for namecard', link: '/supabase/db/attendee' },
+              { text: 'Staff (Core, Volunteer)', link: '/supabase/db/staff' },
+            ],
+          },
+        ],
+      },
     ],
 
     sidebar: [
@@ -19,7 +37,25 @@ export default defineConfig({
         items: [
           { text: 'CSS', link: '/css/getting-started' },
           { text: 'Peatix', link: '/peatix/csv-usage' },
-          { text: 'Supabase', link: '/supabase/getting-started' },
+          {
+            text: 'Supabase',
+            items: [
+              {
+                text: 'Getting Started',
+                link: '/supabase/getting-started',
+              },
+              {
+                text: 'Database',
+                items: [
+                  { text: 'Speaker, Paneler', link: '/supabase/db/speaker' },
+                  { text: 'Sponsor', link: '/supabase/db/sponsor' },
+                  { text: 'Job for jobboard', link: '/supabase/db/job' },
+                  { text: 'Attendee for namecard', link: '/supabase/db/attendee' },
+                  { text: 'Staff (Core, Volunteer)', link: '/supabase/db/staff' },
+                ],
+              },
+            ],
+          },
         ],
       },
     ],

diff --git a/apps/web-docs/supabase/db/attendee.md b/apps/web-docs/supabase/db/attendee.md
@@ -0,0 +1,28 @@
+# 参加者
+
+## 対象
+
+いずれも照合を経て、注文番号照合完了 or 注文番号照合失敗を果たした者も含んでいます。
+
+- 「一般チケットチケット」購入者のうち、注文番号照合中を果たした者
+- 「一般 + アフターパーティーチケット」購入者のうち、注文番号照合中を果たした者
+
+## 詳細設計
+
+| # | type | initial | required |
+|:----|:----|:----|:----|
+| id | uuid |  |  |
+| user_id | uuid |  | ◯ |
+| email | varchar(100) |  | ◯ |
+| avatar_url | varchar(500) |  | ◯ |
+| provider | varchar(20) |  | ◯ |
+| display_name | varchar(24) |  |  |
+| role | varchar(16) |  |  |
+| receipt_id | varchar(20) |  | ◯ |
+| activated_at | timestamp |  |  |
+| created_at | timestamp | `now()` | (auto) |
+| updated_at | timestamp | `now()` | (auto) |
+
+## 参照
+
+https://github.com/vuejs-jp/vuefes-2024/blob/main/supabase/schema.sql#L177
diff --git a/apps/web-docs/supabase/db/job.md b/apps/web-docs/supabase/db/job.md
@@ -0,0 +1,27 @@
+# ジョブ
+
+::: tip
+スポンサーと DB を分けました。
+:::
+
+## 対象
+
+- シルバー以上 (プラチナ、ゴールド、シルバー) のスポンサー
+
+## 詳細設計
+
+| # | type | initial | required |
+|:----|:----|:----|:----|
+| id | uuid |  |  |
+| sponsor_id | uuid |  | ◯ |
+| link_url | varchar(500) |  |  |
+| image_url | varchar(500) |  |  |
+| image_alt | varchar(100) |  |  |
+| display_order | int |  |  |
+| is_open | bool |  | ◯ |
+| created_at | timestamp | `now()` | (auto) |
+| updated_at | timestamp | `now()` | (auto) |
+
+## 参照
+
+https://github.com/vuejs-jp/vuefes-2024/blob/main/supabase/schema.sql#L55
diff --git a/apps/web-docs/supabase/db/speaker.md b/apps/web-docs/supabase/db/speaker.md
@@ -0,0 +1,50 @@
+# スピーカー
+
+## 対象
+
+- 海外・招待スピーカー
+- 日本・招待スピーカー
+- 海外・Call for Paper (CfP) スピーカー
+- 日本・Call for Paper (CfP) スピーカー
+- スポンサーセッションスピーカー
+- パネラー (次世代フロントエンドクロストーク、Vue.js コミュニティにようこそ！)
+
+## 詳細設計
+
+| # | type | initial | required |
+|:----|:----|:----|:----|
+| id | uuid |  |  |
+| detail_page_id | varchar(40) |  |  |
+| name_ja | varchar(100) |  | ◯ |
+| name_en | varchar(100) |  | ◯ |
+| image_url | varchar(500) |  |  |
+| company_ja | varchar(100) |  |  |
+| company_en | varchar(100) |  |  |
+| position_ja | varchar(100) |  |  |
+| position_en | varchar(100) |  |  |
+| description_ja | varchar(200) |  | ◯ |
+| description_en | varchar(200) |  | ◯ |
+| github_id | varchar(100) |  |  |
+| x_id | varchar(100) |  |  |
+| session_type | varchar(100) |  |  |
+| session_title_ja | varchar(100) |  |  |
+| session_title_en | varchar(100) |  |  |
+| session_description_ja | varchar(1000) |  |  |
+| session_description_ja | varchar(1000) |  |  |
+| session_comment_ja | varchar(200) |  |  |
+| session_comment_ja | varchar(200) |  |  |
+| session_place | varchar(100) |  |  |
+| session_time_from | timestamp |  |  |
+| session_time_duration | int |  |  |
+| session_doc_title_ja | varchar(200) |  |  |
+| session_doc_title_en | varchar(200) |  |  |
+| session_doc_url | varchar(200) |  |  |
+| events | text array |  |  |
+| display_order | int |  |  |
+| is_open | bool |  | ◯ |
+| created_at | timestamp | `now()` | (auto) |
+| updated_at | timestamp | `now()` | (auto) |
+
+## 参照
+
+https://github.com/vuejs-jp/vuefes-2024/blob/main/supabase/schema.sql#L84
diff --git a/apps/web-docs/supabase/db/sponsor.md b/apps/web-docs/supabase/db/sponsor.md
@@ -0,0 +1,29 @@
+# スポンサー
+
+## 対象
+
+- プラチナ、ゴールド、シルバー、ブロンズ
+- スペシャルネーミングライツ、ネーミングライツ、スペシャルランチ、ランチ、アフターパーティー、ネームカード、同時通訳、託児サポート、ハンズオン、メディア、ツール
+
+## 詳細設計
+
+| # | type | initial | required |
+|:----|:----|:----|:----|
+| id | uuid |  |  |
+| detail_page_id | varchar(40) |  |  |
+| name | varchar(100) |  | ◯ |
+| description_ja | varchar(500) |  | ◯ |
+| description_en | varchar(500) |  | ◯ |
+| link_url | varchar(500) |  |  |
+| image_url | varchar(500) |  |  |
+| share_image_url | varchar(500) |  |  |
+| speaker_id | varchar(100) |  |  |
+| tag | text array |  |  |
+| display_order | int |  |  |
+| is_open | bool |  | ◯ |
+| created_at | timestamp | `now()` | (auto) |
+| updated_at | timestamp | `now()` | (auto) |
+
+## 参照
+
+https://github.com/vuejs-jp/vuefes-2024/blob/main/supabase/schema.sql#L18
diff --git a/apps/web-docs/supabase/db/staff.md b/apps/web-docs/supabase/db/staff.md
@@ -0,0 +1,25 @@
+# スタッフ
+
+## 対象
+
+- コアスタッフ
+- ボランティアスタッフ
+
+## 詳細設計
+
+| # | type | initial | required |
+|:----|:----|:----|:----|
+| id | uuid |  |  |
+| detail_page_id | varchar(40) |  |  |
+| image_url | varchar(500) |  |  |
+| name | varchar(100) |  | ◯ |
+| x_id | varchar(100) |  |  |
+| github_id | varchar(100) |  |  |
+| is_volunteer | bool |  |  |
+| is_open | bool |  | ◯ |
+| created_at | timestamp | `now()` | (auto) |
+| updated_at | timestamp | `now()` | (auto) |
+
+## 参照
+
+https://github.com/vuejs-jp/vuefes-2024/blob/main/supabase/schema.sql#L146