Spaces:
Sleeping
Sleeping
Upload folder using huggingface_hub
Browse files- GITHUB_PAGES_SETUP.md +135 -0
GITHUB_PAGES_SETUP.md
ADDED
|
@@ -0,0 +1,135 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# GitHub Pages セットアップ手順
|
| 2 |
+
|
| 3 |
+
## 📝 手動セットアップ(推奨)
|
| 4 |
+
|
| 5 |
+
### 1. GitHubリポジトリを作成
|
| 6 |
+
|
| 7 |
+
1. https://github.com/new にアクセス
|
| 8 |
+
2. 以下の設定でリポジトリを作成:
|
| 9 |
+
- **Repository name**: `api-workflow-builder`
|
| 10 |
+
- **Description**: `🚀 Visual API Workflow Builder - No-code page builder`
|
| 11 |
+
- **Public** を選択
|
| 12 |
+
- **Initialize this repository with** は全てチェックなし
|
| 13 |
+
3. **Create repository** をクリック
|
| 14 |
+
|
| 15 |
+
### 2. コードをプッシュ
|
| 16 |
+
|
| 17 |
+
PowerShellで以下を実行:
|
| 18 |
+
|
| 19 |
+
```powershell
|
| 20 |
+
cd C:\xampp\htdocs\localProject\api-workflow-builder
|
| 21 |
+
|
| 22 |
+
# Gitの初期設定(まだの場合)
|
| 23 |
+
git config user.name "Your Name"
|
| 24 |
+
git config user.email "your@email.com"
|
| 25 |
+
|
| 26 |
+
# リモートリポジトリを追加
|
| 27 |
+
git remote add github https://github.com/YOUR-USERNAME/api-workflow-builder.git
|
| 28 |
+
|
| 29 |
+
# mainブランチに変更してプッシュ
|
| 30 |
+
git branch -M main
|
| 31 |
+
git push -u github main
|
| 32 |
+
```
|
| 33 |
+
|
| 34 |
+
**注意**: `YOUR-USERNAME` を実際のGitHubユーザー名に置き換えてください
|
| 35 |
+
|
| 36 |
+
### 3. GitHub Pagesを有効化
|
| 37 |
+
|
| 38 |
+
1. リポジトリページ(https://github.com/YOUR-USERNAME/api-workflow-builder)を開く
|
| 39 |
+
2. **Settings** タブをクリック
|
| 40 |
+
3. 左サイドバーの **Pages** をクリック
|
| 41 |
+
4. **Source** セクションで:
|
| 42 |
+
- Branch: `main`
|
| 43 |
+
- Folder: `/ (root)`
|
| 44 |
+
5. **Save** をクリック
|
| 45 |
+
|
| 46 |
+
### 4. 公開URLを確認
|
| 47 |
+
|
| 48 |
+
1-2分後、以下のURLでアクセス可能:
|
| 49 |
+
```
|
| 50 |
+
https://YOUR-USERNAME.github.io/api-workflow-builder/
|
| 51 |
+
```
|
| 52 |
+
|
| 53 |
+
ページビルダーは:
|
| 54 |
+
```
|
| 55 |
+
https://YOUR-USERNAME.github.io/api-workflow-builder/index.html
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
---
|
| 59 |
+
|
| 60 |
+
## 🤖 自動セットアップ(GitHub Tokenが必要)
|
| 61 |
+
|
| 62 |
+
### 1. GitHub Personal Access Token を取得
|
| 63 |
+
|
| 64 |
+
1. https://github.com/settings/tokens/new にアクセス
|
| 65 |
+
2. 設定:
|
| 66 |
+
- **Note**: `api-workflow-builder`
|
| 67 |
+
- **Expiration**: `No expiration` (または任意の期限)
|
| 68 |
+
- **Select scopes**:
|
| 69 |
+
- ✅ `repo` (Full control of private repositories)
|
| 70 |
+
- ✅ `workflow` (Update GitHub Action workflows)
|
| 71 |
+
3. **Generate token** をクリック
|
| 72 |
+
4. トークンをコピー(⚠️ 二度と表示されません)
|
| 73 |
+
|
| 74 |
+
### 2. デプロイスクリプトを実行
|
| 75 |
+
|
| 76 |
+
```powershell
|
| 77 |
+
cd C:\xampp\htdocs\localProject\api-workflow-builder
|
| 78 |
+
python deploy_github.py
|
| 79 |
+
```
|
| 80 |
+
|
| 81 |
+
プロンプトが表示されたら、コピーしたトークンを入力
|
| 82 |
+
|
| 83 |
+
---
|
| 84 |
+
|
| 85 |
+
## ✅ 確認事項
|
| 86 |
+
|
| 87 |
+
デプロイ後、以下を確認:
|
| 88 |
+
|
| 89 |
+
1. **リポジトリが作成されているか**
|
| 90 |
+
- https://github.com/YOUR-USERNAME/api-workflow-builder
|
| 91 |
+
|
| 92 |
+
2. **GitHub Pagesが有効か**
|
| 93 |
+
- Settings → Pages → "Your site is live at..." のメッセージが表示される
|
| 94 |
+
|
| 95 |
+
3. **ページが表示されるか**
|
| 96 |
+
- https://YOUR-USERNAME.github.io/api-workflow-builder/index.html
|
| 97 |
+
- GrapeJSエディタのサイドバーが表示される
|
| 98 |
+
- ブロックがドラッグ&ドロップできる
|
| 99 |
+
|
| 100 |
+
---
|
| 101 |
+
|
| 102 |
+
## 🔧 トラブルシューティング
|
| 103 |
+
|
| 104 |
+
### リポジトリが既に存在する
|
| 105 |
+
|
| 106 |
+
```powershell
|
| 107 |
+
# 既存のリモートを削除
|
| 108 |
+
git remote remove github
|
| 109 |
+
|
| 110 |
+
# 新しいリモートを追加
|
| 111 |
+
git remote add github https://github.com/YOUR-USERNAME/api-workflow-builder.git
|
| 112 |
+
|
| 113 |
+
# 強制プッシュ
|
| 114 |
+
git push -u github main -f
|
| 115 |
+
```
|
| 116 |
+
|
| 117 |
+
### GitHub Pagesが404エラー
|
| 118 |
+
|
| 119 |
+
1. Settings → Pages で正しく設定されているか確認
|
| 120 |
+
2. 1-2分待ってから再度アクセス
|
| 121 |
+
3. リポジトリが Public になっているか確認
|
| 122 |
+
|
| 123 |
+
### index.htmlが表示されない
|
| 124 |
+
|
| 125 |
+
直接URLにアクセス:
|
| 126 |
+
```
|
| 127 |
+
https://YOUR-USERNAME.github.io/api-workflow-builder/index.html
|
| 128 |
+
```
|
| 129 |
+
|
| 130 |
+
---
|
| 131 |
+
|
| 132 |
+
## 📚 参考リンク
|
| 133 |
+
|
| 134 |
+
- [GitHub Pages ドキュメント](https://docs.github.com/en/pages)
|
| 135 |
+
- [Personal Access Token 作成](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
|