今回はGitHubを用いてデプロイしていくため、GitHubアカウントをあらかじめご用意ください。
チュートリアル用GitHubリポジトリを作成する
- GitHubを経由して公開を行います。
GitHubアカウントをまだお持ちでない方は事前に登録をお願いします。 - チュートリアル用のリポジトリを追加しましょう。
設定は基本的に初期値のままで問題ありませんが
公開設定は「Private」を選択します。
リポジトリにPushする
- 以下のコマンドを実行して、作成したリポジトリにpushします。
cd ${作成したチュートリアル用プロジェクトのディレクトリ} git init git add . git commit -m "first commit" git branch -M main git remote add origin https://github.com/${お使いのアカウント}/${任意のリポジトリ名}.git git push -u origin main
SpearlyCLOUDにGitHubでログインする。
SpearlyCLOUDはGitHubとの連携を用いてデプロイを行うため、GitHubアカウントでのログインをお勧めします。それでは以下の手順でユーザー登録を行いましょう。
- SpearlyCLOUDトップを開く
SpearlyCLOUDトップから「新規登録」もしくは「ログイン」をクリックしてください。
- お持ちのGitHubアカウントのメールアドレスかIDとパスワードを入力し、GitHubへログインしてください。

- 初めてログインする場合、SpearlyにGitHubでログインして良いか確認画面が出るため、「Authorize Spearly」をクリックし認証してください。

- SpearlyCLOUDのプロジェクト管理画面が表示されます。
.png)
連携するリポジトリを選択する。
- 「サイトを追加する」を選択
.png)
- GitHubを選択し、「次へ」をクリックします。
.png)
- SpealyCLOUDでデプロイするGitHubのリポジトリを選択します。
Spearlyが読み込めるリポジトリのリストが表示されます。
GitHubで認証しているリポジトリがない場合、No Dataと表示されますので、下記の「GitHubのリポジトリが表示されない場合」を参照ください。
(Organizationのリポジトリは権限がない場合Spearlyで開けないので、そのリポジトリの管理者に問い合わせてください。)
GitHubのリポジトリが表示されない場合
リポジトリを追加しましょう。- 「リポジトリを追加」をクリックします。

- 別ウインドウで開かれたGitHubのページから、SpearlyCLOUDへのリポジトリのインストール方法を選択します。
「All reposirtories」は、全てのリポジトリが選択されます。
「Only select repositories」は選択したリポジトリのみインストールします。
- 「Only select repositories」を選択します。

- 「select repositories」からSpearlyへインストールしたいリポジトリを選択します。

- Spearlyへインストールしたいリポジトリを選択できたら、「install」をクリックします。

- 「save」をクリックしてSpearlyへのリポジトリのインストール完了です。
- SpearlyへGitHubのリポジトリをインストールする
デプロイしたいリポジトリを選び、デプロイのための設定画面へ遷移します。.png)
- 「リポジトリを追加」をクリックします。
サイトをデプロイしよう。
ビルド情報設定を記入し、サイトのデプロイを完了しましょう。- 「サイトを追加する」からデプロイしたいリポジトリを選択し、「次へ」をクリックします。
.png)
- デプロイのための各項目についてここで設定します。
サイトの形式に合わせて必要な設定をしましょう。
チュートリアルのためにダウンロードしたサンプルサイトであれば以下の設定で構いません。- サイト名
spearly-blog - デプロイブランチ
main - ビルドコマンド
# 本チュートリアルでは必要ないので、無記入で構いません。 - Distパス
. - ルートファイル
index.html - エラーファイル
index.html - 環境変数
# 本チュートリアルでは必要ないので無記入で構いません
- サイト名
- 「デプロイ」をクリックして設定完了です。
あとは自動でビルド&デプロイされますので、終了次第、生成されたurlから確認しましょう。.png)
「デプロイ履歴の確認」をクリックして、デプロイ状況を確認しましょう。
一番上の履歴をクリックするとデプロイ状況を確認することができます。
もしデプロイに失敗した場合はデプロイ設定項目をお見直しください。
ビルド状況が進むと、下記の写真のようにログが更新されます。.png)
- urlからサイトを確認する。
進捗率が100%になればデプロイ完了です。
サイトリストの画像の部分をクリックしていただくと、生成されたurlへ遷移することができます。.png)
実行許可ドメインを設定する
- localhostの時と同様に、今回公開したサイトのURLを実行許可ドメインに追加します。
.png)
公開したWEBサイトの動作確認をする
サイトは確認できましたでしょうか。このようにSpearlyCMSとCLOUDを用いることによって簡単にコンテンツを管理、公開することが可能になります。
今後サイトを更新していく際は、指定したGitブランチにpushしていくだけで、自動で更新、デプロイが行われます。
他にも、API呼び出しでコンテンツを表示する方法や、
順番やページネーションのオプションなど、
紹介していない機能がありますので、下記のリンクからぜひご覧になってください。
- TOPページの下部にお問い合わせフォームをSpearlyCMSで埋め込みましょう。
「フォーム機能を使ってみよう」へ - SpearlyのAPIを用いたコンテンツ配信を体験しましょう
「APIをもちいてコンテンツを配信する」へ