セットアップと最初のデプロイ

CLI をインストールします

npm i -g runlot
runlot login

runlot login はブラウザを開いてアカウントのログインを行います。発行されたトークンはコントロールプレーンの URL ごとに ~/.runlot/credentials.json へ保存され、ファイル権限は 0600 に設定されます。

プロジェクトを作成します

npm create runlot@latest my-app
cd my-app

テンプレートには runlot.json、src/index.ts、public/hello.txt、.gitignore と必要なディレクトリだけが含まれます。runlot.json、ワーカーのエントリーポイント、静的アセットのディレクトリで構成されるデプロイ設定をひと目で把握できるよう、最小構成で提供しています。

ディレクトリ名はプロジェクト名として使われ、プロジェクト名はデプロイ URL の最初のラベルになります。そのため、名前は ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ の形式に従う必要があります。形式に合わない場合は作成時に案内します。

デプロイします

runlot deploy

このコマンドはバンドルを作成してアップロードし、新しいバージョンを配信します。プロジェクトがまだない場合は自動で作成されるため、最初のデプロイの前に別途プロジェクトを用意する必要はありません。

デプロイが完了すると、次のような URL が表示されます。

my-app.me.runlot.app

URL の形式は <プロジェクト>.<組織>.runlot.app です。名前のルールは デプロイ URL を参照してください。

データベースを有効にします

runlot.json に 1 行書いてデプロイします。有効にするコマンドはありません。デプロイが宣言を読み、ないものを作ります。

{
  "name": "my-app",
  "main": "src/index.ts",
  "database": true
}

runlot deploy

ログインとファイルストレージも同じ場所に書きます。必要なものだけ書いて構いません。

{
  "database": true,
  "auth": true,
  "storage": true
}

アプリの認証にはデータベースが必要なため、"auth": true だけ書いてもデータベースを一緒に作ります。デプロイの出力が何を作ったかを伝え、すでにあるものは作り直しません。

デプロイ後は、ワーカーから env.db、env.auth、env.storage をすぐに利用できます。接続文字列やシークレットを別途設定する必要はありません。psql の接続情報は runlot pg connect にあります。

次に読むもの

• プロジェクト構成 — runlot.json とエントリーポイントの役割
• env.db — データベースの使い方
• デプロイ URL — URL が決まるルール