Open2

Supabaseのlocal環境構築と、SupabaseCLIについて

まさぴょんまさぴょん

Supabaseのlocal環境構築について

Supabaseをローカル環境で構築する方法について説明します。

学習内容をもとに、記事を書きました🐱

https://zenn.dev/create_quest/articles/36c41271bbffa2

前提条件

Supabaseのlocal開発・環境構築を始めるにあたり、次の2つが必須になります👀

  1. Dockerのインストール
    • SupabaseはDockerコンテナ上で動作するため、Docker のインストールが必須です。
  2. Supabase CLIのインストール
    • Supabase CLIはローカル開発を容易にするためのツールです。

https://supabase.com/docs/guides/local-development/cli/getting-started

npmを使用する場合

npm install -g supabase

Homebrewを使用する場合(macOS)

brew install supabase/tap/supabase

環境構築の手順

1. 新しいプロジェクトの作成

mkdir my-supabase-project
cd my-supabase-project
supabase init

supabase initコマンドを実行することで、supabaseディレクトリと設定ファイルが生成されます。

2. ローカルサーバーの起動

supabase start
  • 初回起動時はDockerイメージのダウンロードが必要なため、時間がかかる場合があります。
  • 起動後、以下のサービスが利用可能になります:
    • PostgreSQLデータベース
    • 認証サービス(Auth)
    • ストレージサービス
    • Realtimeサーバー

3. Supabase Studioへのアクセス

  • ブラウザでhttp://localhost:54323にアクセスして、データベースや認証設定を管理します。

4. アプリケーションからの接続

接続情報はsupabase/.envファイルに記載されています。

SUPABASE_URL=http://localhost:54321
SUPABASE_ANON_KEY=...
SUPABASE_SERVICE_ROLE_KEY=...

追加設定と注意点

ポートの変更

デフォルトのポートを変更する場合は、supabase/config.tomlを編集します。

データの永続化

Supabaseは、Dockerボリュームを使用してデータを永続化しています。
データをリセットしたい場合は、以下のコマンドを実行します。

supabase stop --destroy

サービスの停止

supabase stop

ログの確認

supabase logs

参考・引用

https://supabase.com/docs/guides/local-development/overview

https://dev.classmethod.jp/articles/supabase-graphql/

https://zenn.dev/masatotezuka/articles/supabase_prisma_20230826

https://qiita.com/NagaJun/items/9c7516274566362b0c95

https://zenn.dev/razokulover/articles/db984ebfcf4bf6