TypeScript backend template

環境設定

.env.template をコピーして .env ファイルを作成し、必要な環境変数を設定する。

cp .env.template .env

DB初期化方法

1. 依存関係をインストールする。

   pnpm install --frozen-lockfile

2. マイグレーションを実行するため、以下のコマンドを実行する。

   docker compose up db -d
   pnpm prisma migrate deploy

   テーブルを作成後、prisma/seed.tsが実行され初期データの流し込みが行われる。

3. 作成したコンテナを停止し、削除するために、以下のコマンドを実行する。

   docker compose down

Prismaの使い方

Fastifyのチュートリアル Fastify+Prismaのexample

Prismaスキーマの設定

prisma/schema.prisma を編集して、PostgreSQLのスキーマを定義することができる。

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

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

model users {
  id    Int    @id @default(autoincrement())
  name  String
  email String @unique
}

スキーマの変更をマイグレーションする。

pnpm prisma migrate dev --name suitable_name

その他コマンド類

コマンド	説明
pnpm prisma migrate dev --name suitable_name	Prismaのマイグレーションを開発環境で実行し、指定した名前で新しいマイグレーションを作成する。
pnpm prisma migrate deploy	Prismaのマイグレーションを本番環境に適用する。
pnpm prisma studio	Prisma Studioを起動し、データベースのデータをインタラクティブに操作する。
pnpm test	テストを実行するためのコマンドですが、現在はエラーを出力して終了する（未設定）。
pnpm dev	TypeScriptコードをコンパイルし、dist/index.jsを実行して開発サーバーを起動する。
pnpm start	コンパイル済みのdist/index.jsを実行してアプリケーションを起動する。
pnpm build	TypeScriptコードをコンパイルして、distディレクトリに出力する。
pnpm lint	srcディレクトリ内のコードをbiomeで静的解析し、問題がないかチェックする。
pnpm lint:fix	biomeを使用して、コードの静的解析結果に基づいて自動的に修正する。
pnpm format	biomeを使用して、コードを自動的にフォーマットする。
pnpm psql	.envファイルを読み込み、docker composeを使ってdbコンテナを起動し、psqlを実行してPostgreSQLに接続する。