Zenn
🐡

NestJS×Prisma×Supabase で爆速環境構築

2023/08/26に公開
TypeScript
Prisma
NestJS
supabase
tech

はじめに

最近、Bass で注目されている Supabase が気になり、流行りの NestJS・Prisma を使って環境構築してみました。今回、データの呼び出しは Supabase ではなく、Prisma を使うようにしました。理由は、最初は スモールスタートとして Supabase を使っていたけど、別のサーバーに移行したいとなったときにデータベースだけを移行できるような設計にしたかったからです。
早速、始めていきましょう！

実装

1. NestJS の環境構築

まずは、NestJS のコマンドを使用して新しいアプリを作成します。（パッケージマネージャーは pnpm にしました。）
NestJS は CLI・ライブラリーが充実していて、API をすぐ作成できますよね。

npx nest new nestjs-prisma-supabase-sample-app

2. Prisma の設定

  1. Prisma をインストールします。
pnpm install @prisma/client
  1. 以下のコマンドを実行して、プロジェクトのルートディレクトリに Prisma のプロジェクトを初期化します。.env ファイルと prisma フォルダが作成されれば OK です。
npx prisma init
  1. prisma フォルダ内の schema.prisma ファイルに、データベースのモデルやリレーションシップが定義していきます。マイグレーションするときに参照するファイルになります。
    今回は、schema.prisma に Todo モデルを作成します。
// This is your Prisma schema file,
// learn more about it in the docs: https://pris.ly/d/prisma-schema

generator client {
  provider = "prisma-client-js"
}

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

model Todo {
  id          Int      @id @default(autoincrement())
  title       String
  description String   @unique
  done        Boolean  @default(false)
  createdAt   DateTime @default(now())
}

スキーマの定義については、こちらの公式ドキュメントを参考にしてください。
https://www.prisma.io/docs/reference/api-reference/prisma-schema-reference

下記のコマンドを実行すると、ファイルのをフォーマットとバリデーションをしてくれます。スキーマの設定にミスがあれば教えてくれます。

npx prisma format

Prisma の CLI も充実していて便利です！
https://www.prisma.io/docs/reference/api-reference/command-reference

3. Supabase をローカル環境で構築

.env にあるDATABASE_URLを Supabase のローカル環境の URL に設定するために、Supabase をローカル環境で構築します。

  1. Supabase CLI をインストールします。
brew install supabase/tap/supabase
  1. プロジェクトの初期化
supabase init
  1. supabase フォルダに移動
cd supabase
  1. supabase を起動（Docker を起動するので少し時間がかかります。）
supabase start
  1. 起動が完了したら、ターミナルに DB の URL が表示されます。
API URL: http://localhost:54321
GraphQL URL: http://localhost:54321/graphql/v1
DB URL: postgresql://postgres:postgres@localhost:54322/postgres
Studio URL: http://localhost:54323
Inbucket URL: http://localhost:54324

4. マイグレーション

  1. ローカル環境の Supabase の DB URL を env ファイルにコピーし、ルート直下でマイグレーションを実行します。
npx prisma migrate dev --name init
  1. ローカル環境のスキーマをリモートの Supabase に反映させるために、マイグレーションファイルを Supabase フォルダ下にも作成します。
    下記のコマンドを実行することで、ローカルのデータベースに対して変更したスキーマの変更差分をマイグレーションファイルに書き出しる。
supabase db diff -f init

参考：Supabase CLI reference - Diff local database

5. リモートの Supabase でプロジェクト作成

リモートの Supabase 上にプロジェクトを作成するには、以下の手順を実行してください。

  1. 下記 URL から Supabase の Web サイトにアクセスし、ログインします。

https://supabase.com/

Supabase の登録・プロジェクト作成にの方法についてはこちらのサイトが参考になると思います。
Supabase で PostgreSQL の DB 作成 - Qiita
Getting Started ｜ Supabase でデータベースを使う

  1. ダッシュボード画面で、「New Project」をクリックして、Organization を選択します。

  2. プロジェクト名・パスワードを入力し、「Create Project」をクリックします。

6. ローカルとリモートをリンクさせる

最後に、以下のコマンドを実行して、ローカルとリモートをリンクさせます。

  1. リモートのプロジェクトからプロジェクト ID をコピーします。

  2. ローカルの supabase フォルダ下で、下記のコマンドを実行し、ローカルとリモートをリンクさせます。パスワード入力が求められるので、プロジェクト作成時に作成したパスワードを入力します。

supabase link --project-ref [project-id]
  1. 下記のコマンドを実行して、ローカルのデータベースをリモートに反映させます。
supabase db push
  1. リモートのテーブルを確認すると反映されていることが確認できました。

最後に

以上が、NestJS・Prisma・Supabase を使用してデータベースの本番環境と開発環境を構築する手順です。とても簡単に環境構築できたのではないでしょうか。
API サーバーを本番環境にデプロイするときは、Supabase のリモートプロジェクトのデータベース URL を.env ファイルに設定する必要があると思います。
参考までにリポジトリを添付します。
https://github.com/masatotezuka/nestjs-prisma-supabase-sample-app/tree/main

最後までお読みいただきありがとうございました。

参考サイト

https://blog.gini.co.jp/build-supabase-prisma-environment/

GitHubで編集を提案

Discussion