Supabase CLI に含まれるローカル開発環境

はじめに

みなさんは、BaaS (Backend As A Service) の 1 つ Supabase を利用したことはありますか? 検証やちょっとした個人開発であれば Supabase に直接接続し開発を進めることも選択肢の1つになりますが、 Supabase CLI に内包されている ローカル開発環境 を使えば簡単に手元のマシンに環境を用意できるのでその紹介をしたいと思います。

Supabase CLI とは

はじめに にも記載しましたが、手元のマシンで、Supabase の Project 作成・起動や リモート(supabase.com) のスキーマ情報を取得したり様々なことができるツールです。

準備

Supabase CLI を実行する際には以下のインストールが必要です。

• Docker Desktop 等の Docker 実行環境
• Node.js, Scoop, Homebrew のいずれか

上記準備が整ったら Supabase CLI をインストールします。

Docker Desktop 等の Docker 実行環境

Supabase CLI はバックグラウンドに Docker Desktop を使用します。 下記リンクもしくは Homebrew 等で Docker Desktop をインストールしてください。

brew install --cask docker

Docker Desktop 以外にも下記ツールでも実行可能なようです。 必要に応じてインストールを実行してください。

• Rancher Desktop (macOS, Windows, Linux)
• Podman (macOS, Windows, Linux)
• OrbStack (macOS)
• colima (macOS)

Node.js, Scoop, Homebrew のいずれか

下記リンクから、 Node.js, Scoop, Homebrew のうち1つは実行できるように設定してください。 すでにインストールされている場合この手順をスキップしてください。

Supabase CLI のインストール

下記リンク内の手順にそってインストールを進めます。

私は Homebrew を選択したので 下記コマンドを実行しました。

brew install supabase/tap/supabase

Supabase の起動

使用したい Project のディレクトリに移動し Supabase の初期設定(ファイル生成)と起動を行います。 supabase init を実行すると supabase フォルダ(ディレクトリ)の作成と設定ファイル生成を行ってくれます。

cd /path/to/project-dir
supabase init

生成された Toml ファイルを確認し、 Project 名や起動ポート等必要に応じて編集します。 編集が終わったら supabase start で Supabse を起動します。

supabase start

旧バージョンでは Storage 等使えない機能もありましたが、現在は Storage 含め使えるようになっています。

Ref