セットアップ
使い方目次
- アプリケーションをローカルで起動する手順
- 手順1. パッケージをインストール
- 手順2. envに各種の値を設定
- 手順3. ローカルサーバーを起動
- 記事に対するコメントの読み書き機能をローカルで有効にする手順
- 手順1. .envの`PUBLIC_IS_USE_COMMENT`をtrueに変更
- 手順2. wranglerをローカルマシンにインストール
- 手順3. データベースを作成
- 手順4. wrangler.tomlにペースト
- 手順5. テーブルを作成
- 手順6. ビルドを実行
- 手順7. データベースに読み書き可能なアプリケーションをローカルにデプロイ
- 留意事項
- 本番環境(Cloudflare Pages)にデプロイする手順
- 本番環境(Cloudflare Pages)でコメント機能を有効にする手順
- 手順1. 本番環境のデータベースにテーブルを作成
- 手順2. Pages Functionsとデータベースをバインド
- 手順3. 再デプロイ
- 下書き状態の記事のプレビューができるURL
アプリケーションをローカルで起動する手順
手順1. パッケージをインストール
npm i
手順2. envに各種の値を設定
env
のファイル名を.env
に変更して、各種の値を設定してください。
手順3. ローカルサーバーを起動
npm run dev
記事に対するコメントの読み書き機能をローカルで有効にする手順
手順1. .envの`PUBLIC_IS_USE_COMMENT`をtrueに変更
下記の変更により、src/routes/[category]/[article]/+page.svelte
にある、comments.svelte
が表示されます。
comments.svelte
はコメントの投稿フォームや一覧を表示するコンポーネントです。
# .env
- PUBLIC_IS_USE_COMMENT="false"
+ PUBLIC_IS_USE_COMMENT="true"
手順2. wranglerをローカルマシンにインストール
npm i -g wrangler
手順3. データベースを作成
下記の<DATABASE_NAME>
は任意の名前に置き換えてください。
wrangler d1 create <DATABASE_NAME>
上記のコマンドを実行すると、ローカルと本番環境でデータベースが作成されます。
また、ターミナルに以下のようなテキストが表示されるので、コピーしてください。
[[d1_databases]]
binding = "DB" # i.e. available in your Worker on env.DB
database_name = "<DATABASE_NAME>"
database_id = "ランダムな文字列"
手順4. wrangler.tomlにペースト
_wrangler.toml
のファイル名をwrangler.toml
に変更して、手順3.でコピーしたテキストをペーストしてください。
手順5. テーブルを作成
下記の<DATABASE_NAME>
は手順3.で設定した値と同様の値に置き換えてください。
wrangler d1 execute <DATABASE_NAME> --local --file=./schema.sql
手順6. ビルドを実行
npm run build
手順7. データベースに読み書き可能なアプリケーションをローカルにデプロイ
npm run d1
ターミナルに下記が表示された後にキーボードのb
を押すことで、ローカルにデプロイされたアプリケーションをブラウザに表示できます。
[b] open a browser, [d] open Devtools, [c] clear console, [x] to exit
上記で開いたアプリケーションで、各記事に対するコメントの読み書きが確認できます。
留意事項
手順7.でローカルにデプロイされたアプリケーションはホットリロードが効きません。
コードの変更を画面に反映させたい場合は、手順6.と手順7.の実行が必要です。
ターミナルで下記のコマンドを入力すると、ファイルの変更を監視できます。
npx vite build -w
ファイルの変更を監視した状態でファイルを変更して保存をすると、自動でビルドが実行されます。
本番環境(Cloudflare Pages)にデプロイする手順
下記のドキュメントを参照してください。
Cloudflare Pages • Docs • SvelteKit
Deploy a Svelte site · Cloudflare Pages docs
上の画像にあるビルドコマンド
とビルド出力ディレクトリ
は、フレームワーク プリセット
でSvelteKit
を選択すると自動で設定される値で問題ありません。
併せてローカルの.env
ファイルで設定した各種の変数名と値を、環境変数(アドバンスド)
にひとつずつ設定してください。
本番環境(Cloudflare Pages)でコメント機能を有効にする手順
手順1. 本番環境のデータベースにテーブルを作成
前述の記事に対するコメントの読み書き機能をローカルで有効にする手順
の手順3. データベースを作成
でデータベースを作成していない場合は、以下のコマンドを実行する前にデータベースを作成してください。
wrangler d1 execute <DATABASE_NAME> --file=./schema.sql
手順2. Pages Functionsとデータベースをバインド
Cloudflare Pagesのアプリケーションごとの設定
→Functions
のページに、D1 データベース バインディング
という項目があります。
プロダクション
タブに切り替えた状態で変数名
をDB
、D1 データベース
は作成したデータベースを選択してください。
手順3. 再デプロイ
再デプロイが完了すると、本番環境でコメントの読み書きが可能になります。
下書き状態の記事のプレビューができるURL
以下のパスにパラメータを渡すと、下書き状態の記事のプレビューができます。
/preview?id={CONTENT_ID}&key={DRAFT_KEY}